From 538ff88fb78aa2e54bef930cea05e99ad63350fd Mon Sep 17 00:00:00 2001 From: tejas bhuwania Date: Mon, 17 Feb 2020 04:54:36 +0530 Subject: [PATCH 01/34] add _site to ignore list --- src/Site.js | 3 ++- src/constants.js | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/src/Site.js b/src/Site.js index ba5c40f70b..5bc2f3b43c 100644 --- a/src/Site.js +++ b/src/Site.js @@ -52,6 +52,7 @@ const { SITE_ASSET_FOLDER_NAME, SITE_CONFIG_NAME, SITE_DATA_NAME, + SITE_FOLDER_NAME, TEMP_FOLDER_NAME, TEMPLATE_SITE_ASSET_FOLDER_NAME, USER_VARIABLES_PATH, @@ -427,7 +428,7 @@ class Site { globPages.concat(walkSync(this.rootPath, { directories: false, globs: [addressableGlob.glob], - ignore: [CONFIG_FOLDER_NAME], + ignore: [CONFIG_FOLDER_NAME, SITE_FOLDER_NAME], }).map(globPath => ({ src: globPath, searchable: addressableGlob.searchable, diff --git a/src/constants.js b/src/constants.js index 984667811b..276ec9fd29 100644 --- a/src/constants.js +++ b/src/constants.js @@ -39,6 +39,7 @@ module.exports = { CONFIG_FOLDER_NAME: '_markbind', HEADING_INDEXING_LEVEL_DEFAULT: 3, SITE_ASSET_FOLDER_NAME: 'asset', + SITE_FOLDER_NAME: '_site', TEMP_FOLDER_NAME: '.temp', TEMPLATE_SITE_ASSET_FOLDER_NAME: 'markbind', From 52e1afac3808880e8e4980e3ad886749907191ca Mon Sep 17 00:00:00 2001 From: tejas bhuwania Date: Mon, 17 Feb 2020 06:14:30 +0530 Subject: [PATCH 02/34] update highlighted text bg color --- docs/css/main.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/css/main.css b/docs/css/main.css index 8f21f99265..92caaa36ed 100644 --- a/docs/css/main.css +++ b/docs/css/main.css @@ -1,5 +1,5 @@ mark { - background-color: rgba(255, 231, 2, 0.15); + background-color: #FFFF00; border-radius: 5px; padding-top: 0; padding-bottom: 0; From 5738a2bb9a9c6b836e1c781b9349486150145a12 Mon Sep 17 00:00:00 2001 From: tejas bhuwania Date: Fri, 28 Feb 2020 03:19:32 +0800 Subject: [PATCH 03/34] add
to code --- docs/userGuide/syntax/siteNavigationMenus.mbdf | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/userGuide/syntax/siteNavigationMenus.mbdf b/docs/userGuide/syntax/siteNavigationMenus.mbdf index eedcc46b54..3648e63fc6 100644 --- a/docs/userGuide/syntax/siteNavigationMenus.mbdf +++ b/docs/userGuide/syntax/siteNavigationMenus.mbdf @@ -14,12 +14,15 @@ Steps to add a siteNav: * [:house: Home]({{ showBaseUrlText }}/index.html)
+

* Docs
  * [User Guide]({{ showBaseUrlText }}/ug.html)
  * [Dev Guide]({{ showBaseUrlText }}/dg.html)
+

* [Search]({{ showBaseUrlText }}/search.html)
  * [Google Search](https://www.google.com/)
  * [YouTube Search](https://www.youtube.com/)
+

* [Contact]({{ showBaseUrlText }}/contact.html)
@@ -53,6 +56,7 @@ Here's how the above siteNav will appear:
  • YouTube Search
  • +
  • Contact
  • From 145b97cdbc85823299b99c46d7c4cae0807dd17c Mon Sep 17 00:00:00 2001 From: tejas bhuwania Date: Fri, 28 Feb 2020 03:30:32 +0800 Subject: [PATCH 04/34] update --- docs/userGuide/syntax/siteNavigationMenus.mbdf | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/userGuide/syntax/siteNavigationMenus.mbdf b/docs/userGuide/syntax/siteNavigationMenus.mbdf index 3648e63fc6..a169d9e9b9 100644 --- a/docs/userGuide/syntax/siteNavigationMenus.mbdf +++ b/docs/userGuide/syntax/siteNavigationMenus.mbdf @@ -14,7 +14,7 @@ Steps to add a siteNav: * [:house: Home]({{ showBaseUrlText }}/index.html)
    -

    +--- * Docs
      * [User Guide]({{ showBaseUrlText }}/ug.html)
      * [Dev Guide]({{ showBaseUrlText }}/dg.html)
    @@ -40,6 +40,7 @@ Here's how the above siteNav will appear:
    • 🏠 Home
    • +
    • @@ -50,12 +51,14 @@ Here's how the above siteNav will appear:
    +
  • Search
  • +
  • Contact
  • From 7132f9533cd0336f7661c4050734406a8810d6c2 Mon Sep 17 00:00:00 2001 From: tejas bhuwania Date: Fri, 28 Feb 2020 03:48:24 +0800 Subject: [PATCH 05/34] add
    to output --- docs/userGuide/syntax/siteNavigationMenus.mbdf | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/userGuide/syntax/siteNavigationMenus.mbdf b/docs/userGuide/syntax/siteNavigationMenus.mbdf index a169d9e9b9..3b47edcf1b 100644 --- a/docs/userGuide/syntax/siteNavigationMenus.mbdf +++ b/docs/userGuide/syntax/siteNavigationMenus.mbdf @@ -41,6 +41,7 @@ Here's how the above siteNav will appear: From d5b91ffbb887421a23437e559f12dd4ef849f5fc Mon Sep 17 00:00:00 2001 From: tejas bhuwania Date: Fri, 28 Feb 2020 03:49:49 +0800 Subject: [PATCH 06/34] add
    to code --- docs/userGuide/syntax/siteNavigationMenus.mbdf | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/userGuide/syntax/siteNavigationMenus.mbdf b/docs/userGuide/syntax/siteNavigationMenus.mbdf index 3b47edcf1b..2fbd249c73 100644 --- a/docs/userGuide/syntax/siteNavigationMenus.mbdf +++ b/docs/userGuide/syntax/siteNavigationMenus.mbdf @@ -15,6 +15,7 @@ Steps to add a siteNav: * [:house: Home]({{ showBaseUrlText }}/index.html)
    --- +

    * Docs
      * [User Guide]({{ showBaseUrlText }}/ug.html)
      * [Dev Guide]({{ showBaseUrlText }}/dg.html)
    From 27c11d746009cc3cc5bea4914c4cdec2ce27a9b8 Mon Sep 17 00:00:00 2001 From: tejas bhuwania Date: Fri, 28 Feb 2020 03:53:54 +0800 Subject: [PATCH 07/34] update to make it consistent --- docs/userGuide/syntax/siteNavigationMenus.mbdf | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/docs/userGuide/syntax/siteNavigationMenus.mbdf b/docs/userGuide/syntax/siteNavigationMenus.mbdf index 2fbd249c73..c0a074c72f 100644 --- a/docs/userGuide/syntax/siteNavigationMenus.mbdf +++ b/docs/userGuide/syntax/siteNavigationMenus.mbdf @@ -15,15 +15,14 @@ Steps to add a siteNav: * [:house: Home]({{ showBaseUrlText }}/index.html)
    --- -

    * Docs
      * [User Guide]({{ showBaseUrlText }}/ug.html)
      * [Dev Guide]({{ showBaseUrlText }}/dg.html)
    -

    +--- * [Search]({{ showBaseUrlText }}/search.html)
      * [Google Search](https://www.google.com/)
      * [YouTube Search](https://www.youtube.com/)
    -

    +--- * [Contact]({{ showBaseUrlText }}/contact.html)
    @@ -42,7 +41,6 @@ Here's how the above siteNav will appear: From 34d25630f0e3d3a2d897295b3a550c93c5bca85d Mon Sep 17 00:00:00 2001 From: tejas bhuwania Date: Fri, 28 Feb 2020 04:00:42 +0800 Subject: [PATCH 08/34] correct input indentation --- docs/userGuide/syntax/siteNavigationMenus.mbdf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/userGuide/syntax/siteNavigationMenus.mbdf b/docs/userGuide/syntax/siteNavigationMenus.mbdf index c0a074c72f..6b29fe8d6b 100644 --- a/docs/userGuide/syntax/siteNavigationMenus.mbdf +++ b/docs/userGuide/syntax/siteNavigationMenus.mbdf @@ -15,7 +15,7 @@ Steps to add a siteNav: * [:house: Home]({{ showBaseUrlText }}/index.html)
    --- -* Docs
    +
    * Docs
      * [User Guide]({{ showBaseUrlText }}/ug.html)
      * [Dev Guide]({{ showBaseUrlText }}/dg.html)
    --- From f64773ae788ed52a5d93273f534262b4447b0f1e Mon Sep 17 00:00:00 2001 From: tejas bhuwania Date: Fri, 28 Feb 2020 04:04:25 +0800 Subject: [PATCH 09/34] update --- docs/userGuide/syntax/siteNavigationMenus.mbdf | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/userGuide/syntax/siteNavigationMenus.mbdf b/docs/userGuide/syntax/siteNavigationMenus.mbdf index 6b29fe8d6b..c89b454f80 100644 --- a/docs/userGuide/syntax/siteNavigationMenus.mbdf +++ b/docs/userGuide/syntax/siteNavigationMenus.mbdf @@ -19,11 +19,11 @@ Steps to add a siteNav:   * [User Guide]({{ showBaseUrlText }}/ug.html)
      * [Dev Guide]({{ showBaseUrlText }}/dg.html)
    --- -* [Search]({{ showBaseUrlText }}/search.html)
    +
    * [Search]({{ showBaseUrlText }}/search.html)
      * [Google Search](https://www.google.com/)
      * [YouTube Search](https://www.youtube.com/)
    --- -* [Contact]({{ showBaseUrlText }}/contact.html) +
    * [Contact]({{ showBaseUrlText }}/contact.html)
    From 8b5e5d9ded0ea94886a5d4b98f1a440b46233f47 Mon Sep 17 00:00:00 2001 From: Tejas Bhuwania <35946746+Tejas2805@users.noreply.github.com> Date: Fri, 28 Feb 2020 18:57:19 +0800 Subject: [PATCH 10/34] update code to code blocks --- .../userGuide/syntax/siteNavigationMenus.mbdf | 28 ++++++++----------- 1 file changed, 11 insertions(+), 17 deletions(-) diff --git a/docs/userGuide/syntax/siteNavigationMenus.mbdf b/docs/userGuide/syntax/siteNavigationMenus.mbdf index c89b454f80..d239de435d 100644 --- a/docs/userGuide/syntax/siteNavigationMenus.mbdf +++ b/docs/userGuide/syntax/siteNavigationMenus.mbdf @@ -3,7 +3,7 @@ **A _Site Navigation Menu_ (==_siteNav_ for short==) is a fixed menu on the ==left edge== of a page**, that can be used to show a road map of the main pages of your site. Steps to add a siteNav: -1. Format your siteNav as an unordered Markdown list and save it inside the `_markbind/navigation` directory. +1. Format your siteNav as an unordered Markdown list and save it inside the `_markbind/navigation` directory. You may include dividers in the siteNav via [horizontal rules]({{ showBaseUrlText }}/userguide/readerfacingfeatures#horizontal-rules) 2. Specify the file as the value of the `siteNav` attribute in the `` of the page.
    @@ -12,19 +12,16 @@ Steps to add a siteNav: - -* [:house: Home]({{ showBaseUrlText }}/index.html)
    ---- -
    * Docs
    -  * [User Guide]({{ showBaseUrlText }}/ug.html)
    -  * [Dev Guide]({{ showBaseUrlText }}/dg.html)
    ---- -
    * [Search]({{ showBaseUrlText }}/search.html)
    -  * [Google Search](https://www.google.com/)
    -  * [YouTube Search](https://www.youtube.com/)
    ---- -
    * [Contact]({{ showBaseUrlText }}/contact.html) -
    +```{.no-line-numbers} +* [:house: Home]({{ showBaseUrlText }}/index.html) +* Docs + * [User Guide]({{ showBaseUrlText }}/ug.html) + * [Dev Guide]({{ showBaseUrlText }}/dg.html) +* [Search]({{ showBaseUrlText }}/search.html) + * [Google Search](https://www.google.com/) + * [YouTube Search](https://www.youtube.com/) +* [Contact]({{ showBaseUrlText }}/contact.html) +```
    Here's how another page can make use of the above siteNav: @@ -40,7 +37,6 @@ Here's how the above siteNav will appear:
    • 🏠 Home
    • -
    • @@ -51,14 +47,12 @@ Here's how the above siteNav will appear:
    -
  • Search
  • -
  • Contact
  • From 8ef5aa5395ed94610b7cd76f5a6ab556740f4e74 Mon Sep 17 00:00:00 2001 From: Tejas Bhuwania <35946746+Tejas2805@users.noreply.github.com> Date: Fri, 28 Feb 2020 19:01:39 +0800 Subject: [PATCH 11/34] Update siteNavigationMenus.mbdf --- docs/userGuide/syntax/siteNavigationMenus.mbdf | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/userGuide/syntax/siteNavigationMenus.mbdf b/docs/userGuide/syntax/siteNavigationMenus.mbdf index d239de435d..d0f78dc259 100644 --- a/docs/userGuide/syntax/siteNavigationMenus.mbdf +++ b/docs/userGuide/syntax/siteNavigationMenus.mbdf @@ -10,8 +10,6 @@ Steps to add a siteNav: {{ icon_example }} Here is an example siteNav code saved in **`_markbind/navigation/`**`mySiteNav.md` file: - - ```{.no-line-numbers} * [:house: Home]({{ showBaseUrlText }}/index.html) * Docs @@ -22,7 +20,6 @@ Steps to add a siteNav: * [YouTube Search](https://www.youtube.com/) * [Contact]({{ showBaseUrlText }}/contact.html) ``` - Here's how another page can make use of the above siteNav: From 45331b04122c642ebeb6db7e08eb8a6afd388624 Mon Sep 17 00:00:00 2001 From: Tejas Bhuwania <35946746+Tejas2805@users.noreply.github.com> Date: Fri, 28 Feb 2020 19:19:43 +0800 Subject: [PATCH 12/34] Update siteNavigationMenus.mbdf --- docs/userGuide/syntax/siteNavigationMenus.mbdf | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/userGuide/syntax/siteNavigationMenus.mbdf b/docs/userGuide/syntax/siteNavigationMenus.mbdf index d0f78dc259..d6e8dd2b72 100644 --- a/docs/userGuide/syntax/siteNavigationMenus.mbdf +++ b/docs/userGuide/syntax/siteNavigationMenus.mbdf @@ -3,7 +3,7 @@ **A _Site Navigation Menu_ (==_siteNav_ for short==) is a fixed menu on the ==left edge== of a page**, that can be used to show a road map of the main pages of your site. Steps to add a siteNav: -1. Format your siteNav as an unordered Markdown list and save it inside the `_markbind/navigation` directory. You may include dividers in the siteNav via [horizontal rules]({{ showBaseUrlText }}/userguide/readerfacingfeatures#horizontal-rules) +1. Format your siteNav as an unordered Markdown list and save it inside the `_markbind/navigation` directory. You may include dividers in the siteNav via horizontal rules. 2. Specify the file as the value of the `siteNav` attribute in the `` of the page.
    @@ -11,14 +11,14 @@ Steps to add a siteNav: {{ icon_example }} Here is an example siteNav code saved in **`_markbind/navigation/`**`mySiteNav.md` file: ```{.no-line-numbers} -* [:house: Home]({{ showBaseUrlText }}/index.html) +* [:house: Home]({{ baseUrl }}/index.html) * Docs - * [User Guide]({{ showBaseUrlText }}/ug.html) - * [Dev Guide]({{ showBaseUrlText }}/dg.html) -* [Search]({{ showBaseUrlText }}/search.html) + * [User Guide]({{ baseUrl }}/ug.html) + * [Dev Guide]({{ baseUrl }}/dg.html) +* [Search]({{ baseUrl }}/search.html) * [Google Search](https://www.google.com/) * [YouTube Search](https://www.youtube.com/) -* [Contact]({{ showBaseUrlText }}/contact.html) +* [Contact]({{ baseUrl }}/contact.html) ``` Here's how another page can make use of the above siteNav: From 5f0a6abc08167dd5b33c04e3f0e178034c77bdb9 Mon Sep 17 00:00:00 2001 From: Tejas Bhuwania <35946746+Tejas2805@users.noreply.github.com> Date: Mon, 2 Mar 2020 01:33:00 +0800 Subject: [PATCH 13/34] Update docs/userGuide/syntax/siteNavigationMenus.mbdf Co-Authored-By: nbriannl --- docs/userGuide/syntax/siteNavigationMenus.mbdf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/userGuide/syntax/siteNavigationMenus.mbdf b/docs/userGuide/syntax/siteNavigationMenus.mbdf index d6e8dd2b72..d09e3aef77 100644 --- a/docs/userGuide/syntax/siteNavigationMenus.mbdf +++ b/docs/userGuide/syntax/siteNavigationMenus.mbdf @@ -50,7 +50,7 @@ Here's how the above siteNav will appear:
  • YouTube Search
  • -
  • Contact
  • +
  • Contact
  • From cd3e2de9a7fa8c2a94643294f74c7cd5b6d760db Mon Sep 17 00:00:00 2001 From: Tejas Bhuwania <35946746+Tejas2805@users.noreply.github.com> Date: Mon, 2 Mar 2020 01:41:29 +0800 Subject: [PATCH 14/34] Update siteNavigationMenus.mbdf --- docs/userGuide/syntax/siteNavigationMenus.mbdf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/userGuide/syntax/siteNavigationMenus.mbdf b/docs/userGuide/syntax/siteNavigationMenus.mbdf index d09e3aef77..7db07cb09c 100644 --- a/docs/userGuide/syntax/siteNavigationMenus.mbdf +++ b/docs/userGuide/syntax/siteNavigationMenus.mbdf @@ -83,7 +83,7 @@ You may have additional HTML and Markdown content in a horizontal rules. +1. Format your siteNav as an unordered Markdown list and save it inside the `_markbind/navigation` directory. You may include dividers in the siteNav via horizontal rules. 2. Specify the file as the value of the `siteNav` attribute in the `` of the page.
    From ba9078fafd7e48b328630c55e716094090afccfb Mon Sep 17 00:00:00 2001 From: tejas bhuwania Date: Wed, 4 Mar 2020 17:30:41 +0800 Subject: [PATCH 16/34] add hr to code and output --- docs/userGuide/syntax/siteNavigationMenus.mbdf | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/userGuide/syntax/siteNavigationMenus.mbdf b/docs/userGuide/syntax/siteNavigationMenus.mbdf index 7f021b611a..30a4d1460b 100644 --- a/docs/userGuide/syntax/siteNavigationMenus.mbdf +++ b/docs/userGuide/syntax/siteNavigationMenus.mbdf @@ -12,12 +12,15 @@ Steps to add a siteNav: ```{.no-line-numbers} * [:house: Home]({{ baseUrl }}/index.html) +--- * Docs * [User Guide]({{ baseUrl }}/ug.html) * [Dev Guide]({{ baseUrl }}/dg.html) * [Search]({{ baseUrl }}/search.html) +--- * [Google Search](https://www.google.com/) * [YouTube Search](https://www.youtube.com/) +--- * [Contact]({{ baseUrl }}/contact.html) ``` @@ -34,6 +37,7 @@ Here's how the above siteNav will appear:
    • 🏠 Home
    • +
    • @@ -44,12 +48,14 @@ Here's how the above siteNav will appear:
    +
  • Search
  • +
  • Contact
  • From db6399c2ac18206965f8460c9ef5aa1628a3f4ec Mon Sep 17 00:00:00 2001 From: tejas bhuwania Date: Wed, 4 Mar 2020 17:50:21 +0800 Subject: [PATCH 17/34] use code blocks in pageHeader --- docs/userGuide/syntax/pageHead.mbdf | 28 ++++++++++++---------------- 1 file changed, 12 insertions(+), 16 deletions(-) diff --git a/docs/userGuide/syntax/pageHead.mbdf b/docs/userGuide/syntax/pageHead.mbdf index 043caad28c..56d236f76e 100644 --- a/docs/userGuide/syntax/pageHead.mbdf +++ b/docs/userGuide/syntax/pageHead.mbdf @@ -10,13 +10,11 @@ Steps: {{ icon_example }} Suppose you want to insert the code below into the `` of a page, and you have saved the code as **`_markbind/head/`**`myCustomLinks.md`: - - -``
    -``
    -`` - -
    +```{.no-line-numbers} + + + +``` To specify that you want to insert `myCustomLinks.md` into the `` of `myPage.html`, update the front matter of the `myPage.md` as follows: ```html @@ -34,15 +32,13 @@ To specify that you want to insert `myCustomLinks.md` into the `` of `myPa {{ icon_example }} Here's how you can force the line `` to be inserted at the top of the `` section. - - -**``**
    -  ``
    -**`
    `**
    -``
    -`` - -
    +``` +**``** + +**``** + + +``` From 88ff2deaf526e4b3b52d2c756fd94bfa87284544 Mon Sep 17 00:00:00 2001 From: tejas bhuwania Date: Wed, 4 Mar 2020 18:01:37 +0800 Subject: [PATCH 18/34] add highlighting --- docs/userGuide/syntax/pageHead.mbdf | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/userGuide/syntax/pageHead.mbdf b/docs/userGuide/syntax/pageHead.mbdf index 56d236f76e..61747074a6 100644 --- a/docs/userGuide/syntax/pageHead.mbdf +++ b/docs/userGuide/syntax/pageHead.mbdf @@ -10,7 +10,7 @@ Steps: {{ icon_example }} Suppose you want to insert the code below into the `` of a page, and you have saved the code as **`_markbind/head/`**`myCustomLinks.md`: -```{.no-line-numbers} +```html{.no-line-numbers} @@ -32,12 +32,12 @@ To specify that you want to insert `myCustomLinks.md` into the `` of `myPa {{ icon_example }} Here's how you can force the line `` to be inserted at the top of the `` section. -``` -**``** - -**``** - - +```html {highlight-lines="1,3"} + + + + + ``` From d5b928e02eba6c5dc0be04b30a0198ed02d4cd41 Mon Sep 17 00:00:00 2001 From: tejas bhuwania Date: Wed, 4 Mar 2020 18:26:33 +0800 Subject: [PATCH 19/34] update siteNav to code block --- docs/userGuide/syntax/pageHead.mbdf | 20 ++++----- .../userGuide/syntax/siteNavigationMenus.mbdf | 45 +++++++++---------- 2 files changed, 30 insertions(+), 35 deletions(-) diff --git a/docs/userGuide/syntax/pageHead.mbdf b/docs/userGuide/syntax/pageHead.mbdf index 61747074a6..e844cfc9ca 100644 --- a/docs/userGuide/syntax/pageHead.mbdf +++ b/docs/userGuide/syntax/pageHead.mbdf @@ -32,9 +32,9 @@ To specify that you want to insert `myCustomLinks.md` into the `` of `myPa {{ icon_example }} Here's how you can force the line `` to be inserted at the top of the `` section. -```html {highlight-lines="1,3"} +```html {.no-line-numbers} {highlight-lines="1,3"} - + @@ -58,15 +58,13 @@ To specify that you want to insert `myCustomLinks.md` into the `` of `myPa `_markbind/head/myCustomLinks.md`: - - -**``**
    -  ``
    -**`
    `**
    -``
    -`` - -
    +```html{.no-line-numbers} + + + + + +``` ```html diff --git a/docs/userGuide/syntax/siteNavigationMenus.mbdf b/docs/userGuide/syntax/siteNavigationMenus.mbdf index 30a4d1460b..c2d1da818b 100644 --- a/docs/userGuide/syntax/siteNavigationMenus.mbdf +++ b/docs/userGuide/syntax/siteNavigationMenus.mbdf @@ -72,19 +72,17 @@ You may have additional HTML and Markdown content in a - -# Site Map
    -<navigation>
    -* [:house: Home]({{ showBaseUrlText }}/index.html)
    -* Docs :expanded:
    -  * [User Guide]({{ showBaseUrlText }}/ug.html)
    -  * [Dev Guide]({{ showBaseUrlText }}/dg.html)
    -* [Search]({{ showBaseUrlText }}/search.html)
    -</navigation>
    -
    - +```{.no-line-numbers} +# Site Map + +* [:house: Home]({{ baseUrl }}/index.html) +* Docs :expanded: + * [User Guide]({{ baseUrl }}/ug.html) + * [Dev Guide]({{ baseUrl }}/dg.html) +* [Search]({{ baseUrl }}/search.html) + +``` ```html From 9720d63b8d2e35950ef0c5a49d7a534e3dbf657f Mon Sep 17 00:00:00 2001 From: tejas bhuwania Date: Wed, 4 Mar 2020 18:40:22 +0800 Subject: [PATCH 20/34] improve readability --- docs/userGuide/syntax/pageHead.mbdf | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/userGuide/syntax/pageHead.mbdf b/docs/userGuide/syntax/pageHead.mbdf index e844cfc9ca..89e9a27e94 100644 --- a/docs/userGuide/syntax/pageHead.mbdf +++ b/docs/userGuide/syntax/pageHead.mbdf @@ -11,9 +11,9 @@ Steps: {{ icon_example }} Suppose you want to insert the code below into the `` of a page, and you have saved the code as **`_markbind/head/`**`myCustomLinks.md`: ```html{.no-line-numbers} - - - + + + ``` To specify that you want to insert `myCustomLinks.md` into the `` of `myPage.html`, update the front matter of the `myPage.md` as follows: @@ -32,13 +32,15 @@ To specify that you want to insert `myCustomLinks.md` into the `` of `myPa {{ icon_example }} Here's how you can force the line `` to be inserted at the top of the `` section. -```html {.no-line-numbers} {highlight-lines="1,3"} +````{.no-line-numbers} +```html {highlight-lines="1,3"} - + - - + + ``` +```` From fcbeb2a0867443534312e346a60cfa5635684e00 Mon Sep 17 00:00:00 2001 From: tejas bhuwania Date: Sun, 8 Mar 2020 04:16:05 +0800 Subject: [PATCH 21/34] update code blocks with headings --- docs/userGuide/syntax/pageHead.mbdf | 2 -- docs/userGuide/syntax/pageLayouts.mbdf | 15 +++------------ 2 files changed, 3 insertions(+), 14 deletions(-) diff --git a/docs/userGuide/syntax/pageHead.mbdf b/docs/userGuide/syntax/pageHead.mbdf index 89e9a27e94..bfba47a220 100644 --- a/docs/userGuide/syntax/pageHead.mbdf +++ b/docs/userGuide/syntax/pageHead.mbdf @@ -32,7 +32,6 @@ To specify that you want to insert `myCustomLinks.md` into the `` of `myPa {{ icon_example }} Here's how you can force the line `` to be inserted at the top of the `` section. -````{.no-line-numbers} ```html {highlight-lines="1,3"} @@ -40,7 +39,6 @@ To specify that you want to insert `myCustomLinks.md` into the `` of `myPa ``` -```` diff --git a/docs/userGuide/syntax/pageLayouts.mbdf b/docs/userGuide/syntax/pageLayouts.mbdf index 84af369ca1..c829f8e242 100644 --- a/docs/userGuide/syntax/pageLayouts.mbdf +++ b/docs/userGuide/syntax/pageLayouts.mbdf @@ -11,7 +11,7 @@ A layout consists of the following files: 1. A footer (filename: `footer.md`) 1. Tweaks to the `` (`head.md`) 1. A site navigation menu (`navigation.md`) -1. An expressive layout template to embed your content (`page.md`) +1. An expressive layout template to embed your content (`page.md`) 1. Custom styles (`styles.css`) 1. Custom scripts (`scripts.js`) @@ -114,27 +114,18 @@ which injects the actual page content in every page. This allows you to build la {{ icon_example }} Adding statistics formula to the bottom of every page - -index.md -

    - - ```html + ```html {heading="index.md"} #### Main content of your page Content of your page ``` -
    - -page.md -

    {{ mainContentBody }} - ```html + ```html {heading="page.md"} ``` -
    Here's how the above content would appear: From 759d1ca97c3763c858b9a325f01ebcd93afd8574 Mon Sep 17 00:00:00 2001 From: Tejas Bhuwania <35946746+Tejas2805@users.noreply.github.com> Date: Sun, 8 Mar 2020 04:33:32 +0800 Subject: [PATCH 22/34] Update pageHead.mbdf --- docs/userGuide/syntax/pageHead.mbdf | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/userGuide/syntax/pageHead.mbdf b/docs/userGuide/syntax/pageHead.mbdf index bfba47a220..f2b875f92c 100644 --- a/docs/userGuide/syntax/pageHead.mbdf +++ b/docs/userGuide/syntax/pageHead.mbdf @@ -32,7 +32,7 @@ To specify that you want to insert `myCustomLinks.md` into the `` of `myPa {{ icon_example }} Here's how you can force the line `` to be inserted at the top of the `` section. -```html {highlight-lines="1,3"} +```html {highlight-lines="1,3", .no-line-numbers} @@ -58,7 +58,7 @@ To specify that you want to insert `myCustomLinks.md` into the `` of `myPa `_markbind/head/myCustomLinks.md`: -```html{.no-line-numbers} +```html{.no-line-numbers}{highlight-lines="1,3"} From 989eb48540288f4295b67958bdeab445b751120d Mon Sep 17 00:00:00 2001 From: tejas bhuwania Date: Sun, 8 Mar 2020 04:48:23 +0800 Subject: [PATCH 23/34] update --- docs/userGuide/syntax/pageHead.mbdf | 8 ++++---- docs/userGuide/syntax/pageLayouts.mbdf | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/userGuide/syntax/pageHead.mbdf b/docs/userGuide/syntax/pageHead.mbdf index f2b875f92c..d76a205e90 100644 --- a/docs/userGuide/syntax/pageHead.mbdf +++ b/docs/userGuide/syntax/pageHead.mbdf @@ -58,12 +58,12 @@ To specify that you want to insert `myCustomLinks.md` into the `` of `myPa `_markbind/head/myCustomLinks.md`: -```html{.no-line-numbers}{highlight-lines="1,3"} +```html{.no-line-numbers, highlight-lines="1,3"} - + - - + + ``` ```html diff --git a/docs/userGuide/syntax/pageLayouts.mbdf b/docs/userGuide/syntax/pageLayouts.mbdf index c829f8e242..9e52226f86 100644 --- a/docs/userGuide/syntax/pageLayouts.mbdf +++ b/docs/userGuide/syntax/pageLayouts.mbdf @@ -120,8 +120,8 @@ which injects the actual page content in every page. This allows you to build la Content of your page ``` - {{ mainContentBody }} ```html {heading="page.md"} + {{ mainContentBody }} From a2e7043bbebd9d800ca156cced110896ad9cf94f Mon Sep 17 00:00:00 2001 From: tejas bhuwania Date: Sun, 8 Mar 2020 05:21:24 +0800 Subject: [PATCH 24/34] update --- docs/userGuide/plugins/filterTags.mbdf | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/userGuide/plugins/filterTags.mbdf b/docs/userGuide/plugins/filterTags.mbdf index 4b63f6ce42..5a4aadd5e7 100644 --- a/docs/userGuide/plugins/filterTags.mbdf +++ b/docs/userGuide/plugins/filterTags.mbdf @@ -110,8 +110,7 @@ Using `-` at the start of a tag hides all tags matching the expression. This is
    {{ icon_example }} Using general tags: -```html -index.md +```html {heading="index.md"} title: "Hello World" @@ -123,8 +122,7 @@ index.md

    print("Hello world")

    ``` -```json -site.json +```json {heading="site.json"} { ... From 3cc4bd4b505a529c5f9caab9ec3b2d5087cc7dfa Mon Sep 17 00:00:00 2001 From: tejas bhuwania Date: Sun, 8 Mar 2020 05:42:09 +0800 Subject: [PATCH 25/34] update files --- docs/userGuide/plugins/filterTags.mbdf | 2 -- docs/userGuide/syntax/pageLayouts.mbdf | 4 ++-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/userGuide/plugins/filterTags.mbdf b/docs/userGuide/plugins/filterTags.mbdf index 5a4aadd5e7..cd1e6335c2 100644 --- a/docs/userGuide/plugins/filterTags.mbdf +++ b/docs/userGuide/plugins/filterTags.mbdf @@ -111,7 +111,6 @@ Using `-` at the start of a tag hides all tags matching the expression. This is {{ icon_example }} Using general tags: ```html {heading="index.md"} - title: "Hello World" tags: ["language--java"] @@ -123,7 +122,6 @@ Using `-` at the start of a tag hides all tags matching the expression. This is ``` ```json {heading="site.json"} - { ... "plugins" : [ diff --git a/docs/userGuide/syntax/pageLayouts.mbdf b/docs/userGuide/syntax/pageLayouts.mbdf index 9e52226f86..186a76477c 100644 --- a/docs/userGuide/syntax/pageLayouts.mbdf +++ b/docs/userGuide/syntax/pageLayouts.mbdf @@ -120,8 +120,8 @@ which injects the actual page content in every page. This allows you to build la Content of your page ``` - ```html {heading="page.md"} - {{ mainContentBody }} + ```html {heading="page.md", highlight-lines="1"} + MAIN_CONTENT_BODY From 174af213eff54443d85e6896ddd014cb5f0193bb Mon Sep 17 00:00:00 2001 From: Tejas Bhuwania <35946746+Tejas2805@users.noreply.github.com> Date: Tue, 10 Mar 2020 16:52:28 +0800 Subject: [PATCH 26/34] remove commas --- docs/userGuide/syntax/pageHead.mbdf | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/userGuide/syntax/pageHead.mbdf b/docs/userGuide/syntax/pageHead.mbdf index d76a205e90..09a6b1312d 100644 --- a/docs/userGuide/syntax/pageHead.mbdf +++ b/docs/userGuide/syntax/pageHead.mbdf @@ -32,7 +32,7 @@ To specify that you want to insert `myCustomLinks.md` into the `` of `myPa {{ icon_example }} Here's how you can force the line `` to be inserted at the top of the `` section. -```html {highlight-lines="1,3", .no-line-numbers} +```html {highlight-lines="1,3" .no-line-numbers} @@ -58,7 +58,7 @@ To specify that you want to insert `myCustomLinks.md` into the `` of `myPa `_markbind/head/myCustomLinks.md`: -```html{.no-line-numbers, highlight-lines="1,3"} +```html{.no-line-numbers highlight-lines="1,3"} From 9bf918008d73113e3d22d6ea7611b309804e2220 Mon Sep 17 00:00:00 2001 From: Tejas Bhuwania <35946746+Tejas2805@users.noreply.github.com> Date: Thu, 12 Mar 2020 17:54:26 +0800 Subject: [PATCH 27/34] Update pageLayouts.mbdf --- docs/userGuide/syntax/pageLayouts.mbdf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/userGuide/syntax/pageLayouts.mbdf b/docs/userGuide/syntax/pageLayouts.mbdf index 186a76477c..e0ac5561b3 100644 --- a/docs/userGuide/syntax/pageLayouts.mbdf +++ b/docs/userGuide/syntax/pageLayouts.mbdf @@ -121,7 +121,7 @@ which injects the actual page content in every page. This allows you to build la ``` ```html {heading="page.md", highlight-lines="1"} - MAIN_CONTENT_BODY + {{ mainContentBody }} From 76a3d4fd8009f3da50c00c97274edda38f990abe Mon Sep 17 00:00:00 2001 From: Tejas Bhuwania <35946746+Tejas2805@users.noreply.github.com> Date: Thu, 12 Mar 2020 17:55:51 +0800 Subject: [PATCH 28/34] Update pageHead.mbdf --- docs/userGuide/syntax/pageHead.mbdf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/userGuide/syntax/pageHead.mbdf b/docs/userGuide/syntax/pageHead.mbdf index 09a6b1312d..8975115082 100644 --- a/docs/userGuide/syntax/pageHead.mbdf +++ b/docs/userGuide/syntax/pageHead.mbdf @@ -32,7 +32,7 @@ To specify that you want to insert `myCustomLinks.md` into the `` of `myPa {{ icon_example }} Here's how you can force the line `` to be inserted at the top of the `` section. -```html {highlight-lines="1,3" .no-line-numbers} +```html {.no-line-numbers highlight-lines="1,3"} From f6249aa828daf0468b300a9111797a7c12184773 Mon Sep 17 00:00:00 2001 From: Tejas Bhuwania <35946746+Tejas2805@users.noreply.github.com> Date: Thu, 12 Mar 2020 18:03:44 +0800 Subject: [PATCH 29/34] Update pageLayouts.mbdf --- docs/userGuide/syntax/pageLayouts.mbdf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/userGuide/syntax/pageLayouts.mbdf b/docs/userGuide/syntax/pageLayouts.mbdf index e0ac5561b3..ae738a67a2 100644 --- a/docs/userGuide/syntax/pageLayouts.mbdf +++ b/docs/userGuide/syntax/pageLayouts.mbdf @@ -120,7 +120,7 @@ which injects the actual page content in every page. This allows you to build la Content of your page ``` - ```html {heading="page.md", highlight-lines="1"} + ```html {heading="page.md"} {{ mainContentBody }} From 555bd9d32c07c28f2a33e312c502792fc7f57e8f Mon Sep 17 00:00:00 2001 From: Tejas Bhuwania <35946746+Tejas2805@users.noreply.github.com> Date: Fri, 13 Mar 2020 01:52:33 +0800 Subject: [PATCH 30/34] Update pageLayouts.mbdf --- docs/userGuide/syntax/pageLayouts.mbdf | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/userGuide/syntax/pageLayouts.mbdf b/docs/userGuide/syntax/pageLayouts.mbdf index ae738a67a2..67a67a6df1 100644 --- a/docs/userGuide/syntax/pageLayouts.mbdf +++ b/docs/userGuide/syntax/pageLayouts.mbdf @@ -121,7 +121,9 @@ which injects the actual page content in every page. This allows you to build la ``` ```html {heading="page.md"} - {{ mainContentBody }} + + {​{ MAIN_CONTENT_BODY }} + From 5adc1ea76925d6790927e56e21264c87c77d45ae Mon Sep 17 00:00:00 2001 From: Tejas Bhuwania <35946746+Tejas2805@users.noreply.github.com> Date: Fri, 13 Mar 2020 07:14:10 +0800 Subject: [PATCH 31/34] Update pageLayouts.mbdf --- docs/userGuide/syntax/pageLayouts.mbdf | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/docs/userGuide/syntax/pageLayouts.mbdf b/docs/userGuide/syntax/pageLayouts.mbdf index 67a67a6df1..1a809aecfe 100644 --- a/docs/userGuide/syntax/pageLayouts.mbdf +++ b/docs/userGuide/syntax/pageLayouts.mbdf @@ -1,5 +1,5 @@ -{{ MAIN_CONTENT_BODY }} +{​{ MAIN_CONTENT_BODY }} ## Page Layouts @@ -121,9 +121,6 @@ which injects the actual page content in every page. This allows you to build la ``` ```html {heading="page.md"} - - {​{ MAIN_CONTENT_BODY }} - From 1442e8dbd0e588c964a33a4a39a3008df2f30576 Mon Sep 17 00:00:00 2001 From: Tejas Bhuwania <35946746+Tejas2805@users.noreply.github.com> Date: Fri, 13 Mar 2020 13:56:54 +0800 Subject: [PATCH 32/34] Update pageLayouts.mbdf --- docs/userGuide/syntax/pageLayouts.mbdf | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/userGuide/syntax/pageLayouts.mbdf b/docs/userGuide/syntax/pageLayouts.mbdf index 1a809aecfe..bdedeeb7ac 100644 --- a/docs/userGuide/syntax/pageLayouts.mbdf +++ b/docs/userGuide/syntax/pageLayouts.mbdf @@ -121,6 +121,7 @@ which injects the actual page content in every page. This allows you to build la ``` ```html {heading="page.md"} + {{ mainContentBody }} From 3b7b526eed7aefd59ae9911b1ddd4a12e1561e73 Mon Sep 17 00:00:00 2001 From: tejas bhuwania Date: Fri, 13 Mar 2020 18:10:52 +0800 Subject: [PATCH 33/34] add todo comment and explanation --- docs/userGuide/syntax/pageLayouts.mbdf | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/userGuide/syntax/pageLayouts.mbdf b/docs/userGuide/syntax/pageLayouts.mbdf index bdedeeb7ac..9b890b953a 100644 --- a/docs/userGuide/syntax/pageLayouts.mbdf +++ b/docs/userGuide/syntax/pageLayouts.mbdf @@ -1,3 +1,7 @@ + {​{ MAIN_CONTENT_BODY }} From 7b1d9a87ed09c759336b5380fe460cfeb5ad36fc Mon Sep 17 00:00:00 2001 From: Tejas Bhuwania <35946746+Tejas2805@users.noreply.github.com> Date: Sun, 15 Mar 2020 03:53:35 +0800 Subject: [PATCH 34/34] Update pageLayouts.mbdf --- docs/userGuide/syntax/pageLayouts.mbdf | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/userGuide/syntax/pageLayouts.mbdf b/docs/userGuide/syntax/pageLayouts.mbdf index 9b890b953a..f5fe9e24d5 100644 --- a/docs/userGuide/syntax/pageLayouts.mbdf +++ b/docs/userGuide/syntax/pageLayouts.mbdf @@ -1,9 +1,8 @@ -{​{ MAIN_CONTENT_BODY }} +{{ MAIN_CONTENT_BODY }} ## Page Layouts