• HOME
  • USER GUIDE
  • SHOWCASE
  • ABOUT
  • [_User Guide → MarkBind Syntax Overview_](markBindSyntaxOverview.html)

    MarkBind Syntax Overview

    A MarkBind source file may contain a mix of several popular syntax schemes used in creating web pages. MarkBind source file can be as simple as basic Markdown, and you can use progressively more complicated syntax to create progressively more sophisticated Web pages while optimizing other aspects such as content reuse.

    Given below is an overview of the syntax schemes supported by MarkBind.

    Exact usage of various MarkBind syntax is described in separate sections such as User Guide → Formatting Contents

    Support for Markdown

    MarkBind supports all basic Markdown syntax.

    CODE:

    ### Heading level 3
    ...
    ###### Heading level 6
    

    OUTPUT:

    Heading level 3

    ...

    Heading level 6

    CODE:

    **Bold**, _Italic_, ___Bold and Italic___, `Inline Code`
    

    OUTPUT:

    Bold, Italic, Bold and Italic, Inline Code

    CODE:

    MarkBind home is at [here](https://markbind.org).
    

    OUTPUT:

    MarkBind home is at here.

    Support for GFMD

    MarkBind supports additional Markdown features provided by Github-Flavored Markdown (GFMD).

    CODE:

    ```xml
    <foo>
      <bar type="name">goo</bar>
    </foo>
    ```
    

    OUTPUT:

    <foo>
      <bar type="name">goo</bar>
    </foo>
    

    CODE:

    - [ ] Item 1
       - [ ] Sub item 1.1
       - [x] Sub item 1.2
    - [x] Item 2
    - [ ] Item 3
    

    OUTPUT:

    • Item 1
      • Sub item 1.1
      • Sub item 1.2
    • Item 2
    • Item 3

    CODE:

    :+1: :exclamation: :x: :construction:
    

    OUTPUT:

    👍 ❗️ ❌ 🚧

    MarkBind Extensions to Markdown

    MarkBind adds several Markdown-like features on top of GFMD.

    CODE:

    ****Super Bold****, ++Underline++, ==Highlight==, %%Dim%%
    

    OUTPUT:

    Super Bold, Underline, Highlight, Dim

    CODE:

    - ( ) Item 1
    - ( ) Item 2
    - (x) Item 3
    

    OUTPUT:

    CODE:

    **Normal footnotes:**
    Here is a footnote reference,[^1] and another.[^longnote]
    
    [^1]: Here is the footnote. Footnotes will appear at the bottom of the page.
    
    [^longnote]: Here's one with multiple blocks.
    
        Subsequent paragraphs are indented to show that they
    belong to the previous footnote.
    
    
    **Inline footnotes:**
    Here is an inline note.^[Inlines notes are easier to write, since
    you don't have to pick an identifier and move down to type the
    note.]
    
    

    OUTPUT:

    Normal footnotes: Here is a footnote reference, [1] and another. [2]

    Inline footnotes: Here is an inline note. [3]

    MarkBind Custom Syntax

    Given below are some examples of custom syntax added by MarkBind.

    MarkBind variables are ideal for reusing small bits of code in multiple places; you can define a variable to represent the code bit in question and reuse it anywhere in the site by referring the variable instead of duplicating the code bit.


    MarkBind has a powerful <include> mechanism which allows you to create documents by combining other content fragments.


    MarkBind provides a number of components (e.g., expandable panels, tabbed displays, navigation bars, etc.) that you can use to enhance the appearance/behavior of your pages.


    Support for HTML, JavaScript, CSS

    A MarkBind source file can contain a mixture of HTML, JavaScript, and CSS as a normal web page would.


    Support for VueStrap and BootStrap

    As MarkBind uses VueStrap (which in turn is based on BootStrap) internally, many of their syntax work within MarkBind files too.

    Support for Nunjucks

    Nunjucks is a JavaScript based templating tool. Here is a simple example:

    <ul>
    {% for item in [1, 2, 3, 4] %}
    <li>Item {{ item }}</li>
    {% endfor %}
    </ul>

    • Item 1
    • Item 2
    • Item 3
    • Item 4

    As MarkBind uses Nunjucks behind the scene, MarkBind is generally compatible with Nunjucks, which means you can use Nunjucks templating in your source files. Note that the code is processed for Nunjucks syntax before the rest of the MarkBind syntax are processed.

    Adding Pages

    Formatting Contents



    1. Here is the footnote. Footnotes will appear at the bottom of the page.

    2. Here's one with multiple blocks.

      Subsequent paragraphs are indented to show that they belong to the previous footnote.

    3. Inlines notes are easier to write, since you don't have to pick an identifier and move down to type the note.

    Here is the footnote. Footnotes will appear at the bottom of the page.

    Here's one with multiple blocks.

    Subsequent paragraphs are indented to show that they belong to the previous footnote.

    Inlines notes are easier to write, since you don't have to pick an identifier and move down to type the note.