Fix several broken links

ang-zeyu · Jun 13, 2020 · 14262d4 · 14262d4
1 parent b53bf6c
commit 14262d4
Show file tree

Hide file tree

Showing 10 changed files with 12 additions and 12 deletions.
diff --git a/docs/_markbind/layouts/userGuide/navigation.md b/docs/_markbind/layouts/userGuide/navigation.md
@@ -25,7 +25,7 @@
   * [Reader-Facing Features]({{baseUrl}}/userGuide/readerFacingFeatures.html)
   * [Full Syntax Reference]({{baseUrl}}/userGuide/fullSyntaxReference.html)
   * [Syntax Cheat Sheet]({{baseUrl}}/userGuide/syntaxCheatSheet.html)
-  * [`site.json` File]({{baseUrl}}/userGuide/siteJasonFile.html)
+  * [`site.json` File]({{baseUrl}}/userGuide/siteJsonFile.html)
   * [Tips & Tricks]({{baseUrl}}/userGuide/tipsAndTricks.html)
   * [Glossary]({{baseUrl}}/userGuide/glossary.html)
 </navigation>
diff --git a/docs/_markbind/variables.md b/docs/_markbind/variables.md
@@ -11,7 +11,7 @@
 <variable name="icon_info">:fas-info-circle:</variable>
 <variable name="icon_ticked">:far-check-square:</variable>
 
-<variable name="link_live_preview">[live preview](userGuide/glossary.html#live-preview)</variable>
+<variable name="link_live_preview">[live preview](glossary.html#live-preview)</variable>
 
 <variable name="tooltip_root_directory"><tooltip content="The directory that contains all the project files. It is also the directory in which the `site.json` configuration file is located.">root directory</tooltip></variable>
 
diff --git a/docs/index.md b/docs/index.md
@@ -132,7 +132,7 @@ MarkBind is **highly optimized for creating text-heavy websites** %%e.g., eLearn
 Here are some examples:
 <div class="indented">
 
-<big>:fas-heart:</big> **Icons** can improve the readability of a text-heavy document. MarkBind comes with a wide selection of [icons](userGuide/markBindSyntax.html#icons-fonts) and [emoji](userGuide/markBindSyntax.html#emoji).<br>
+<big>:fas-heart:</big> **Icons** can improve the readability of a text-heavy document. MarkBind comes with a wide selection of [icons](userGuide/formattingContents.html#icons) and [emoji](userGuide/formattingContents.html#emoji).<br>
 <big>:fas-search:</big> With MarkBind's [**search feature**](userGuide/makingTheSiteSearchable.html), you can allow readers to search for keywords in your site.<br>
 <big>:fas-window-maximize:</big> MarkBind allows you to add [**site/page navigation menus, headers, footers**](userGuide/tweakingThePageStructure.html) easily.
 </div>

diff --git a/docs/userGuide/addingPages.md b/docs/userGuide/addingPages.md
@@ -25,7 +25,7 @@
 
 </div>
 
-%%You can specify which files to be omitted from the site by using the `ignore` field in the `site.config` file as explained [here](siteConfiguration.html#ignore).%%
+%%You can specify which files to be omitted from the site by using the `ignore` field in the `site.config` file as explained [here](siteJsonFile.html#ignore).%%
 
 **More importantly, `.md` and `.mbd` files can be transformed into html pages with matching names.**
 
@@ -37,7 +37,7 @@
 
 Here are the steps to add a new page to your site:
 1. Add a `.md` (or `.mbd`) file anywhere inside the root directory.
-1. Update the [`pages` attribute of the `site.json`](siteConfiguration.html#pages) to cover the new file, if necessary.
+1. Update the [`pages` attribute of the `site.json`](siteJsonFile.html#pages) to cover the new file, if necessary.
 1. Use the <trigger trigger="click" for="modal:addingPages-livePreview">live preview</trigger> to view the generated web page for the new file.
 
 <modal large header="Live Preview" id="modal:addingPages-livePreview">

diff --git a/docs/userGuide/deployingTheSite.md b/docs/userGuide/deployingTheSite.md
@@ -28,7 +28,7 @@ Steps for deploying multiple MarkBind sites:
 1. Create multiple `site.json` files. Ensure that the [`baseUrl` property of each `site.json` file](siteJsonFile.html#baseUrl) matches its deploy location.
 1. (Optional) Use the [`markbind serve -s <file>` command](cliCommands.html#serve-command) to stage each site locally and confirm the contents are as expected.
 1. For each site:
-    1. Use the [`markbind build -s <file>` command](cliCommands#build-command) to generate the site from source files.
+    1. Use the [`markbind build -s <file>` command](cliCommands.html#build-command) to generate the site from source files.
     1. Upload the site files to the Web server. The sections below explain how to automate this step if you are deploying to some online platforms.
 
 

diff --git a/docs/userGuide/syntax/frontmatter.mbdf b/docs/userGuide/syntax/frontmatter.mbdf
@@ -23,7 +23,7 @@
 * **`title`**: The title of the page. Will be used as the `<title>` attribute of the HTML page generated.
 * Other properties such as `keywords`, `layout`, `head` etc. will be explained in other places of this user guide.
 
-<include src="../siteConfiguration.md#page-property-overriding" />
+<include src="../siteJsonFile.md#page-property-overriding" />
 
 <span id="short" class="d-none">
 

diff --git a/docs/userGuide/syntax/searchBars.mbdf b/docs/userGuide/syntax/searchBars.mbdf
@@ -45,7 +45,7 @@ placeholder | `String` | `''` | The placeholder text shown when no keywords are
 
 Note: If you are using MarkBind's search functionality, then `enableSearch` **must be set to `true` in `site.json`**.
 
-See: [User Guide: Site Configuration → enableSearch]({{ baseUrl }}/userGuide/siteConfiguration.html#enable-search).
+See: [User Guide: Site Configuration → enableSearch]({{ baseUrl }}/userGuide/siteJsonFile.html#enable-search).
 
 </box>
 

diff --git 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 <a href="{{ baseUrl }}/userGuide/readerfacingfeatures#horizontal-rules">horizontal rules</a>.
+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 <a href="{{ baseUrl }}/userGuide/readerfacingfeatures.html#horizontal-rules">horizontal rules</a>.
 2. Specify the file as the value of the `siteNav` attribute in the `<frontmatter>` of the page.
 
 <div class="indented">

diff --git a/docs/userGuide/syntax/thumbnails.mbdf b/docs/userGuide/syntax/thumbnails.mbdf
@@ -28,7 +28,7 @@ font-color | `string` | | The color of the text, affects normal text and icons (
 font-size | `string` | | Text size, defaults to half of `size`, affects text, icons and emojis
 size | `string` | 100 | The size of the thumbnail in pixels
 src | `string` | | The URL of the image.<br>The URL can be specified as absolute or relative references. More info in: _[Intra-Site Links]({{baseUrl}}/userGuide/formattingContents.html#intraSiteLinks)_
-text | `string` | | The text to use in the thumbnail, [icons]({{baseUrl}}/userGuide/formattingContents#icons), [emojis]({{baseUrl}}/userGuide/formattingContents#emoji) and markdown are supported here
+text | `string` | | The text to use in the thumbnail, [icons]({{baseUrl}}/userGuide/formattingContents.html#icons), [emojis]({{baseUrl}}/userGuide/formattingContents.html#emoji) and markdown are supported here
 
 <box type="info">
 

diff --git a/docs/userGuide/syntax/variables.mbdf b/docs/userGuide/syntax/variables.mbdf
@@ -55,8 +55,8 @@ MarkBind also provides a number of built-in variables.
 
 Variable | Notes | {{ icon_example }} | Output
 --- | --- | --- | ---
-`baseUrl` | Represents the root directory of the site on the server, as configured in your [site configuration]({{baseUrl}}/userGuide/siteConfiguration.html#baseurl) file. <br> Used for specifying [intra-site links](links.mbdf#intraSiteLinks"). | If `baseUrl` is specified as `userGuide/`:<br><br> `<img src="{% raw %}{{baseUrl}}{% endraw %}/images/logo.png" />` | `<img src="userGuide/images/logo.png" />`
-`timestamp` | The time stamp that indicates when the page was generated. <br><br> The [default]({{baseUrl}}/userGuide/siteConfiguration.html#timezone) values of `"timeZone"` and `"locale"` are `"UTC"` and `"en-GB"` respectively.  | The following example showcases the use of the `"Asia/Singapore"` time zone.<br><br> `Page generated at: {% raw %}{{timestamp}}{% endraw %}` | `Page generated at: {{ timestamp }}`
+`baseUrl` | Represents the root directory of the site on the server, as configured in your [site configuration]({{baseUrl}}/userGuide/siteJsonFile.html#baseurl) file. <br> Used for specifying [intra-site links](../formattingContents.html#intra-site-links). | If `baseUrl` is specified as `userGuide/`:<br><br> `<img src="{% raw %}{{baseUrl}}{% endraw %}/images/logo.png" />` | `<img src="userGuide/images/logo.png" />`
+`timestamp` | The time stamp that indicates when the page was generated. <br><br> The [default]({{baseUrl}}/userGuide/siteJsonFile.html#timezone) values of `"timeZone"` and `"locale"` are `"UTC"` and `"en-GB"` respectively.  | The following example showcases the use of the `"Asia/Singapore"` time zone.<br><br> `Page generated at: {% raw %}{{timestamp}}{% endraw %}` | `Page generated at: {{ timestamp }}`
 `MarkBind` | The MarkBind version in use, linked to the MarkBind website. | `Page generated by: {% raw %}{{MarkBind}}{% endraw %}`  | `Page generated by:` {{ MarkBind | safe }}
-Original file line number
+Diff line change
@@ Expand Up @@
     Note: If you are using MarkBind's search functionality, then `enableSearch` **must be set to `true` in `site.json`**.
-    See: [User Guide: Site Configuration → enableSearch]({{ baseUrl }}/userGuide/siteConfiguration.html#enable-search).
+    See: [User Guide: Site Configuration → enableSearch]({{ baseUrl }}/userGuide/siteJsonFile.html#enable-search).
     </box>
@@ Expand Down @@