diff options
Diffstat (limited to 'exampleSite')
| -rw-r--r-- | exampleSite/config.toml | 8 | ||||
| -rw-r--r-- | exampleSite/content/configuration/_index.md | 43 | ||||
| -rw-r--r-- | exampleSite/content/shortcodes/_index.md | 2 |
3 files changed, 50 insertions, 3 deletions
diff --git a/exampleSite/config.toml b/exampleSite/config.toml index 586b318..bf57954 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -17,7 +17,7 @@ googleAnalytics = "" [params] ordersectionsby = "weight" # ordersectionsby = "title" disableSearch = false # default is false -disableNavChevron = false # set true to hide next/prev chevron, default is false +disableReadmoreNav = false # set true to hide prev/next navigation, default is false highlightClientSide = false # set true to use highlight.pack.js instead of the default hugo chroma highlighter menushortcutsnewtab = true # set true to open shortcuts links to a new tab/window @@ -37,5 +37,9 @@ weight = 1 [[menu.shortcuts]] name = "<i class='fab fa-github'></i>" url = "https://github.com/vantagedesign/ace-documentation" -weight = 10 +weight = 2 +[[menu.shortcuts]] +name = "<button class='btn btn-success mt-n1'>Download</button>" +url = "https://github.com/vantagedesign/ace-documentation/releases" +weight = 3
\ No newline at end of file diff --git a/exampleSite/content/configuration/_index.md b/exampleSite/content/configuration/_index.md new file mode 100644 index 0000000..dd05a47 --- /dev/null +++ b/exampleSite/content/configuration/_index.md @@ -0,0 +1,43 @@ ++++ +title = "Configuration" +description = "" +weight = 2 ++++ + +{{< lead >}} +Customize and tweak Ace using a number of configuration options. +{{< /lead >}} + + +## Page ordering + +By default, pages are sorted on the weight assigned to them in their <code>frontmatter</code>. This is set in <code>config.toml</code>, using <code>orderSectionsby = "weight"</code>. Change this to <code>"title"</code> to sort pages alphabetically based on their title instead. Alternatively, do not assign a weight to any pages and it will also sort them alphabetically on their title. + + +## Table of contents + +By default, a table of contents (ToC) is generated for each page in the right side menu. This can be disabled using: + +{{< code >}} +toc = false +{{< /code >}} + +in the <code>config.toml</code> or the <code>frontmatter</code> (a page's markdown file) for a page-wide or page-specific disabling of the ToC respectively. + +## Google Analytics + +Enable Google Analytics by adding your GA tracking ID to the <code>config.toml</code> file, at: +{{< code >}} +googleAnalytics = "XX-XXXXXXXXX-X" +{{< /code >}} +Where <code>XX-XXXXXXXXX-X</code> is your tracking ID. + + +## Read more navigation + +In <code>config.toml</code> or a page's <code>frontmatter</code>, set <code>disableReadmoreNav = true</code> to disable the prev/next buttons at the buttom of every page. + + +## Search + +Disable search by setting <code>disableSearch = true</code> in <code>config.toml</code>.
\ No newline at end of file diff --git a/exampleSite/content/shortcodes/_index.md b/exampleSite/content/shortcodes/_index.md index 70bdaf6..70ecd37 100644 --- a/exampleSite/content/shortcodes/_index.md +++ b/exampleSite/content/shortcodes/_index.md @@ -1,7 +1,7 @@ +++ title = "Shortcodes" description = "" -weight = 0 +weight = 3 +++ {{< lead >}} |