Skip to content
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
14 changes: 9 additions & 5 deletions docs/common/header.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,15 @@
<dropdown text="User Guide">
<li><a href="{{baseUrl}}/userGuide/index.html">Home</a></li>
<li><a href="{{baseUrl}}/userGuide/userQuickStart.html">Quick Start</a></li>
<li role="separator" class="divider"></li>
<li><a href="{{baseUrl}}/userGuide/developingASite.html">Developing a Site</a>
<li><a href="{{baseUrl}}/userGuide/siteConfiguration.html">◦&nbsp; Site Configuration</a></li>
<li role="separator" class="divider"></li>
<li><a href="{{baseUrl}}/userGuide/contentAuthoring.html">Content Authoring</a></li>
<li><a href="{{baseUrl}}/userGuide/developingASite.html">Developing a Site</a></li>
<li><a href="{{baseUrl}}/userGuide/ghpagesDeployment.html">Github Pages Deployment</a></li>
<li><a href="{{baseUrl}}/userGuide/includingContents.html">Including Contents</a></li>
<li><a href="{{baseUrl}}/userGuide/siteConfiguration.html">Site Configuration</a></li>
<li><a href="{{baseUrl}}/userGuide/netlifyPreview.html">Preview site on Netlify</a></li>
<li><a href="{{baseUrl}}/userGuide/includingContents.html">◦&nbsp; Including Contents</a></li>
<li role="separator" class="divider"></li>
<li style="margin: 3px 20px;">Deploying a Site</li>
<li><a href="{{baseUrl}}/userGuide/ghpagesDeployment.html">◦&nbsp; Github Pages Deployment</a></li>
<li><a href="{{baseUrl}}/userGuide/netlifyPreview.html">◦&nbsp; Preview site on Netlify</a></li>
</dropdown>
</navbar>
11 changes: 6 additions & 5 deletions docs/common/userGuideSections.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
## Sections
- <a href="{{baseUrl}}/userGuide/userQuickStart.html">Quick Start</a>
- <a href="{{baseUrl}}/userGuide/contentAuthoring.html">Content Authoring</a>
- <a href="{{baseUrl}}/userGuide/developingASite.html">Developing a Site</a>
- <a href="{{baseUrl}}/userGuide/ghpagesDeployment.html">Github Pages Deployment</a>
- <a href="{{baseUrl}}/userGuide/includingContents.html">Including Contents</a>
- <a href="{{baseUrl}}/userGuide/siteConfiguration.html">Site Configuration</a>
- <a href="{{baseUrl}}/userGuide/netlifyPreview.html">Preview site on Netlify</a>
- <a href="{{baseUrl}}/userGuide/siteConfiguration.html">Site Configuration</a>
- <a href="{{baseUrl}}/userGuide/contentAuthoring.html">Content Authoring</a>
- <a href="{{baseUrl}}/userGuide/includingContents.html">Including Contents</a>
- Deploying a Site
- <a href="{{baseUrl}}/userGuide/ghpagesDeployment.html">Github Pages Deployment</a>
- <a href="{{baseUrl}}/userGuide/netlifyPreview.html">Preview site on Netlify</a>
22 changes: 0 additions & 22 deletions docs/css/main.css
Original file line number Diff line number Diff line change
Expand Up @@ -12,25 +12,3 @@
mark {
background-color: yellow;
}

.important {
color: #980000;
}

.question-wrapper .radio-list,
.question-wrapper .task-list {
list-style: none;
padding-left:0;
}

.radio-list-input, .task-list-item-checkbox {
margin-right: 10px!important;
}

.block-embed {
text-align: center;
}

.closeable-show {
padding: 4px;
}
16 changes: 8 additions & 8 deletions docs/site.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,25 @@
"src": "userGuide/userQuickStart.md",
"title": "MarkBind: User Guide - Quick Start"
},
{
"src": "userGuide/contentAuthoring.md",
"title": "MarkBind: User Guide - Content Authoring"
},
{
"src": "userGuide/developingASite.md",
"title": "MarkBind: User Guide - Developing a Site"
},
{
"src": "userGuide/ghpagesDeployment.md",
"title": "MarkBind: User Guide - Github Pages Deploment"
"src": "userGuide/siteConfiguration.md",
"title": "MarkBind: User Guide - Site Configuration"
},
{
"src": "userGuide/contentAuthoring.md",
"title": "MarkBind: User Guide - Content Authoring"
},
{
"src": "userGuide/includingContents.md",
"title": "MarkBind: User Guide - Including Contents"
},
{
"src": "userGuide/siteConfiguration.md",
"title": "MarkBind: User Guide - Site Configuration"
"src": "userGuide/ghpagesDeployment.md",
"title": "MarkBind: User Guide - Github Pages Deployment"
},
{
"src": "userGuide/netlifyPreview.md",
Expand Down
74 changes: 56 additions & 18 deletions docs/userGuide/contentAuthoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
### General writing guide

#### Mixing HTML with Markdown
*MarkBind* allows you to mix HTML with Markdown content.
*MarkBind* allows you to mix HTML with Markdown content.

To separate inline Markdown from HTML elements, enclose inline Markdown content with `<md>` tags.

Expand All @@ -18,7 +18,7 @@ e.g.
<md> # 1: *Markdown* Content </md>
</div>
```
The HTML output will be
The HTML output will be
```
<div>
<span> # 1: <em>Markdown</em> content </span></div>
Expand All @@ -39,7 +39,7 @@ The HTML output will be:
<div>
<h1 id="1-markdown-content">1: <em>Markdown</em> content</h1>
</div>
```
```
In this case, we will get a `h1` header.

Example 2:
Expand All @@ -62,30 +62,30 @@ Use {{showBaseUrl}} for absolute path reference of images and resource files so
### Supported Markdown Syntax

MarkBind support the standard Markdown syntax. Read the [guide](https://guides.github.com/features/mastering-markdown/).

In addition, it supports:

* [Tables](https://help.github.com/articles/organizing-information-with-tables/) (GFM)
* [Strikethrough](https://help.github.com/articles/basic-writing-and-formatting-syntax/#styling-text) (GFM)
* [Emoji](https://www.webpagefx.com/tools/emoji-cheat-sheet/) shortcut.

`:EMOJICODE:`. For example, `:smile:` will be rendered as :smile:.

* [Task List](https://help.github.com/articles/basic-writing-and-formatting-syntax/#task-lists)
* Text Hightlight using `<mark>`

`==Highlight Text==` => `<mark>Highlight Text</mark>`

* Text Underline using `<ins>`

`++Underline Text++` => `<ins>Underline Text</ins>`

* Dimmed Text (Text with grey background)

`%%Dimmed Text%%`

* Radio Button List

```
- ( ) Option 1
- (X) Option 2 (selected)
Expand Down Expand Up @@ -144,7 +144,7 @@ Note: Replace all instances of `-` with `_` in the glyph's name, e.g. <code>{<sp
To use the searchbar, add the following markup to your file.

```
<typeahead :data="searchData" placeholder="Search" :template="titleTemplate" template-name="title" :on-hit="searchCallback"></typeahead>
<typeahead :data="searchData" placeholder="Search" :template="titleTemplate" template-name="title" :on-hit="searchCallback"></typeahead>
```

To use the searchbar within a navbar, add the following markup to your file. The searchbar can be positioned using the slot attribute for the list. The following markup adds a searchbar to the right side of the navbar with appropriate styling.
Expand All @@ -160,18 +160,18 @@ To use the searchbar within a navbar, add the following markup to your file. The
### Use Components

To use a component, just type the corresponding markup in your file. For example, to create a Panel, you just need to write:

```
<panel header="Click to expand" type="seamless">
Panel Content.
</panel>
```
For a list of supported components, refer to the component [doc](https://markbind.github.io/vue-strap/).

For a list of supported components, refer to [VueStrap modified by MarkBind](https://markbind.github.io/vue-strap/).

To make an element closeable, use `v-closeable`.

e.g.
e.g.
```
<img src="schedule/textbook/images/img1.png" height="320px" v-closeable>
```
Expand All @@ -181,6 +181,44 @@ or
...
</div>
```

#### Question body syntax

<panel header=":lock::key: Does MarkBind allow using checkboxes and radio buttons with the Question and Panel components?">
<question>

- ( ) Yes
- ( ) No

<div slot="hint">
Probably yes
</div>
<div slot="answer">
Yes!
</div>
</question>
</panel>
<br>

```html
<panel header=":lock::key: Does MarkBind allow for the use of checkboxes and radio buttons?">
<question>

- ( ) Yes
- ( ) No

<div slot="hint">
Probably yes
</div>
<div slot="answer">
Yes!
</div>
</question>
</panel>
```

Checkboxes can also be used by substituting `- ( )` with `- [ ]`.

### Include Contents

Being able to include different markdown file into the current context is another feature of *MarkBind*. You can create a complex document from different content fragments by including them.
Expand Down
5 changes: 2 additions & 3 deletions docs/userGuide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,9 @@

MarkBind enhances markdown and html documents with extra features that allow you to compose content-extensive website from document fragments at ease.

MarkBind provides many useful markups (customized HTML tags) to help you create complex and interactive components with simple tags such as `<panel>` and `<popover>`. The reference for all supported customized elements could be found at VueStrap modified by MarkBind.
MarkBind provides many useful markups (customized HTML tags) to help you create complex and interactive components with simple tags such as `<panel>` and `<popover>`. The reference for all supported customized elements could be found at [VueStrap modified by MarkBind](https://markbind.github.io/vue-strap/).

For users, take a look at the [quick start guide](userQuickStart.html) to start building your website with MarkBind. For contributors, take a look at the [developer guide]({{baseUrl}}/developerGuide.html) to start developing MarkBind project.
Take a look at the [quick start guide](userQuickStart.html) to start building your website with MarkBind.

<include src="../common/userGuideSections.md" />
</div>