Skip to content

Commit

Permalink
A few more user guide fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
ang-zeyu committed Dec 6, 2020
1 parent c300609 commit 64ee5af
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 6 deletions.
3 changes: 3 additions & 0 deletions docs/userGuide/syntax/pageNavigationMenus.mbdf
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@

1. **Specify the smallest heading level you want to be included** within the `<frontmatter>` of a page with <tooltip content="The value `default` will use `headingIndexingLevel` within `site.json`.">`"default"`</tooltip> or a <tooltip content="HTML defines six levels of headings, numbered from <br>`1 to 6`.">`heading level`</tooltip>.

<box type="info" seamless>

The `default` level uses the [`headingIndexingLevel` property]({{baseUrl}}/userGuide/siteJsonFile.html#headingindexinglevel) of your site configuration file.
</box>

2. **(Optional) You may also specify a page navigation title** within `<frontmatter>` that will be placed at the top of the page navigation menu.

Expand Down
4 changes: 2 additions & 2 deletions docs/userGuide/syntax/siteNavigationMenus.mbdf
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

<div id="content">

**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.
**A _Site Navigation Menu_ (==_siteNav_ for short==) 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
2. Include it under a `<site-nav>` element.

<div id="short">
Expand Down
8 changes: 4 additions & 4 deletions docs/userGuide/tweakingThePageStructure.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Next, edit the layout file to your liking, and add the `{% raw %}{{ content }}{%
<!-- Insert content after the html <body> tag using the <script-bottom> tag -->
<script-bottom>
<script>
console.log('Hi!')
alert('Hi!')
</script>
</script-bottom>
```
Expand All @@ -133,10 +133,10 @@ The above example shows the use of the `<head-bottom>` tag to insert a custom st

### Inserting scripts after the `<body>` tag

**You may also insert code after the `<body>` section of the generated HTML page**. This is useful for including custom scripts.
Simply insert the `<script>` tags into a `<script-bottom>` tag.
**You may also insert html code after the `<body>` section of the generated HTML page**. This is useful for including custom scripts.
Simply insert the code / `<script>` tags into a `<script-bottom>` tag.

The above example shows the use of the `<head-bottom>` tag to insert a custom stylesheet (`main.css`).
The above example shows the use of the `<script-bottom>` tag to show a browser alert box with the message **'Hi!'**.

<box type=info seamless>

Expand Down

0 comments on commit 64ee5af

Please sign in to comment.