Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure user docs on MarkBind syntax #668

Merged
merged 5 commits into from
Feb 10, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/_markbind/boilerplates/outputBox.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@

%%CODE:%%
<div class="indented">

{{ code | safe }}
</div>

%%OUTPUT:%%
<div class="indented">

<box border-left-color="grey" background-color="white">

{{ output | safe }}
</box>
</div>
9 changes: 7 additions & 2 deletions docs/_markbind/navigation/userGuideSections.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,21 @@
* [Getting Started]({{baseUrl}}/userGuide/gettingStarted.html)
* [Authoring Contents]({{baseUrl}}/userGuide/authoringContents.html)
* [Adding Pages]({{baseUrl}}/userGuide/addingPages.html)
* [MarkBind Syntax]({{baseUrl}}/userGuide/markBindSyntax.html)
* [MarkBind Syntax Overview]({{baseUrl}}/userGuide/markBindSyntaxOverview.html)
* [Formatting Contents]({{baseUrl}}/userGuide/formattingContents.html)
* [Using Components]({{baseUrl}}/userGuide/usingComponents.html)
* [Using HTML, JavaScript, CSS]({{baseUrl}}/userGuide/usingHtmlJavaScriptCss.html)
* [Tweaking the Page Structure]({{baseUrl}}/userGuide/tweakingThePageStructure.html)
* [Reusing Contents]({{baseUrl}}/userGuide/reusingContents.html)
* [Making the Site Searchable]({{baseUrl}}/userGuide/makingTheSiteSearchable.html)
* [Deploying the Site]({{baseUrl}}/userGuide/deployingTheSite.html)
* [MarkBind in the Project Workflow]({{baseUrl}}/userGuide/markBindInTheProjectWorkflow.html)
* References :expanded:
* [CLI Commands]({{baseUrl}}/userGuide/cliCommands.html)
* [Reader-Facing Features]({{baseUrl}}/userGuide/readerFacingFeatures.html)
* [Full Syntax Reference]({{baseUrl}}/userGuide/fullSyntaxReference.html)
* [Syntax Cheat Sheet]({{baseUrl}}/userGuide/syntaxCheatSheet.html)
* [Site Configuration]({{baseUrl}}/userGuide/siteConfiguration.html)
* [Tips, Tricks, & Troubleshooting]({{baseUrl}}/userGuide/tipsTricksAndTroubleshooting.html)
* [Tips & Tricks]({{baseUrl}}/userGuide/tipsAndTricks.html)
* [Glossary]({{baseUrl}}/userGuide/glossary.html)
</navigation>
7 changes: 3 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<frontmatter>
title: "Generate Instructional Websites from Markdown Text"
title: "Generate More Dynamic Websites from Markdown Text"
footer: footer.md
</frontmatter>

Expand All @@ -11,9 +11,8 @@

<span class="lead">

<big>**Generate dynamic websites from Markdown text.**</big>

MarkBind can use Markdown documents to generate <tooltip content="as opposed to _one-size-fits-all_ static content">_more dynamic_</tooltip> websites. MarkBind is ideal for creating text-heavy websites %%e.g., eLearning websites, online instruction manuals, project documentation etc.%%.
<big>**Generate <tooltip content="as opposed to _one-size-fits-all_ static content">_more dynamic_</tooltip> websites from Markdown text.**</big>
Optimized for creating text-heavy websites %%e.g., eLearning websites, online instruction manuals, project documentation etc.%%.
</span>

<b-btn variant="primary" href="{{ baseUrl }}/userGuide/">Get Started</b-btn>
Expand Down
11 changes: 9 additions & 2 deletions docs/userGuide/addingPages.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,21 @@
<variable name="title">Adding Pages</variable>
<variable name="filename">addingPages</variable>

<frontmatter>
title: "User Guide: Adding Pages"
title: "User Guide: {{ title }}"
footer: footer.md
siteNav: userGuideSections.md
</frontmatter>

<span id="link" class="d-none">
<md>[_User Guide → {{ title }}_]({{ baseUrl }}/userGuide/{{ filename }}.html)</md>
</span>

<include src="../common/header.md" />

<div class="website-content">

# Adding Pages
# {{ title }}

<span class="lead" id="overview">

Expand Down
69 changes: 15 additions & 54 deletions docs/userGuide/authoringContents.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,67 +10,28 @@

# Authoring Contents

<big>**Adding Pages**</big>

<blockquote>

<include src="addingPages.md#overview" inline />
</blockquote>

&nbsp;&nbsp;&nbsp;&nbsp; [Read more ...]({{ baseUrl }}/userGuide/addingPages.html)


<big>**MarkBind Syntax**</big>

<blockquote>

<include src="markBindSyntax.md#overview" inline />
</blockquote>

&nbsp;&nbsp;&nbsp;&nbsp; [Read more ...]({{ baseUrl }}/userGuide/markBindSyntax.html)



<big>**Using Components**</big>

<blockquote>

<include src="usingComponents.md#components-overview" inline />
</blockquote>

&nbsp;&nbsp;&nbsp;&nbsp; [Read more ...]({{ baseUrl }}/userGuide/usingComponents.html)



<big>**Tweaking the Page Structure**</big>

<blockquote>

<include src="tweakingThePageStructure.md#overview" inline />
</blockquote>

&nbsp;&nbsp;&nbsp;&nbsp; [Read more ...]({{ baseUrl }}/userGuide/tweakingThePageStructure.html)


<big>**Reusing Contents**</big>

<blockquote>

<include src="reusingContents.md#overview" inline />
</blockquote>

&nbsp;&nbsp;&nbsp;&nbsp; [Read more ...]({{ baseUrl }}/userGuide/reusingContents.html)


{% set pages = [
['Adding Pages', 'addingPages'],
['MarkBind Syntax Overview', 'markBindSyntaxOverview'],
['Formatting Contents', 'formattingContents'],
['Using Components', 'usingComponents'],
['Using HTML, JavaScript, CSS', 'usingHtmlJavaScriptCss'],
['Tweaking the Page Structure', 'tweakingThePageStructure'],
['Reusing Contents', 'reusingContents'],
['Making the Site Searchable', 'makingTheSiteSearchable']
] %}

<big>**Making the Site Searchable**</big>
{% for page in pages %}
<big>**{{ page[0] }}**</big>

<blockquote>

<include src="makingTheSiteSearchable.md#overview" inline />
<include src="{{ page[1] }}.md#overview" inline />
</blockquote>

&nbsp;&nbsp;&nbsp;&nbsp; [Read more ...]({{ baseUrl }}/userGuide/makingTheSiteSearchable.html)
<span class="indented">More info in: <include src="{{ page[1] }}.md#link" inline trim /></span>

{% endfor %}

</div>
99 changes: 0 additions & 99 deletions docs/userGuide/components/box.md

This file was deleted.

15 changes: 0 additions & 15 deletions docs/userGuide/components/modal.md

This file was deleted.

46 changes: 0 additions & 46 deletions docs/userGuide/components/navbar.md

This file was deleted.

Loading