From c2c502acf4c269a14e77d97cbd478f0b1f38cab2 Mon Sep 17 00:00:00 2001 From: Julian Date: Mon, 11 May 2020 20:48:49 +0200 Subject: Improved references in changelog --- CHANGELOG.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c7c2d91..fd63090 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,10 +1,10 @@ ## Version 1.0.3 - - [FIX] Remove source map imports from JS files (@jhollowe) - - [FIX] Fix minifier error with spacing in next-prev-page (@jhollowe) - - [ADD] Allow disabling the TOC (@jhollowe) - - [ADD] Allow Google Analytics to only track production site (@jhollowe) - - [FIX] Prevent empty heaver toggler (@jhollowe) - - [ADD] New table shortcode for styled tables (fixes issue #2) + - [FIX] Remove source map imports from JS files ([@jhollowe, PR #8](https://github.com/vantagedesign/ace-documentation/pull/8)) + - [FIX] Fix minifier error with spacing in next-prev-page ([@jhollowe, PR #6](https://github.com/vantagedesign/ace-documentation/pull/6)) + - [ADD] Allow disabling the TOC ([@jhollowe, PR #9](https://github.com/vantagedesign/ace-documentation/pull/9) + - [ADD] Allow Google Analytics to only track production site ([@jhollowe, PR #7](https://github.com/vantagedesign/ace-documentation/pull/7)) + - [FIX] Prevent empty heaver toggler ([@jhollowe, PR #3](https://github.com/vantagedesign/ace-documentation/pull/3)) + - [ADD] New table shortcode for styled tables (fixes [issue #2](https://github.com/vantagedesign/ace-documentation/issues/2)) - [FIX] Typo in readme -- cgit v1.2.3 From e8742708ae6bff510ef9dc4b9ee1d9a47be7aaee Mon Sep 17 00:00:00 2001 From: Julian Date: Mon, 11 May 2020 21:02:22 +0200 Subject: Fixed typos in changelog & readme --- CHANGELOG.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index fd63090..ae89172 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,7 @@ ## Version 1.0.3 - [FIX] Remove source map imports from JS files ([@jhollowe, PR #8](https://github.com/vantagedesign/ace-documentation/pull/8)) - [FIX] Fix minifier error with spacing in next-prev-page ([@jhollowe, PR #6](https://github.com/vantagedesign/ace-documentation/pull/6)) - - [ADD] Allow disabling the TOC ([@jhollowe, PR #9](https://github.com/vantagedesign/ace-documentation/pull/9) + - [ADD] Allow disabling the TOC ([@jhollowe, PR #9](https://github.com/vantagedesign/ace-documentation/pull/9)) - [ADD] Allow Google Analytics to only track production site ([@jhollowe, PR #7](https://github.com/vantagedesign/ace-documentation/pull/7)) - [FIX] Prevent empty heaver toggler ([@jhollowe, PR #3](https://github.com/vantagedesign/ace-documentation/pull/3)) - [ADD] New table shortcode for styled tables (fixes [issue #2](https://github.com/vantagedesign/ace-documentation/issues/2)) diff --git a/README.md b/README.md index 74946eb..94e3eec 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ With a minimal design, the attention of users is focused on that which matters: ## Demo & documentation -The documentation for Ace was, of course, built with Ace. Therefore, the documentation for Ace also serves as a demo. +The documentation for Ace was, of course, built with Ace. Therefore, the documentation for Ace also serves as a demo. [Ace demo & documentation](https://docs.vantage-design.com/ace) -- cgit v1.2.3 From 48839f6896049d1d17802433049831ddb26b5db9 Mon Sep 17 00:00:00 2001 From: Julian Date: Mon, 11 May 2020 21:03:43 +0200 Subject: Fixed typo in readme --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 94e3eec..1566407 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,9 @@ With a minimal design, the attention of users is focused on that which matters: ## Demo & documentation -The documentation for Ace was, of course, built with Ace. Therefore, the documentation for Ace also serves as a demo. -[Ace demo & documentation](https://docs.vantage-design.com/ace) +The documentation for Ace was, of course, built with Ace. Therefore, the documentation for Ace also serves as a demo. + + - [Ace demo & documentation](https://docs.vantage-design.com/ace) -- cgit v1.2.3 From a0e75e18a1ad1d9d4dec66c81169e7d5ef9dfd32 Mon Sep 17 00:00:00 2001 From: Julian Date: Mon, 11 May 2020 21:15:02 +0200 Subject: Extended info in readme --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 1566407..5be63c3 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,7 @@ The documentation for Ace was, of course, built with Ace. Therefore, the documen *Note:* this theme only works with Hugo's extended version, due to the SCSS compile functionality. + ## Resources - [Store page](https://vantage-design.com/products/documentation-themes/4/ace-documentation) @@ -42,6 +43,7 @@ The documentation for Ace was, of course, built with Ace. Therefore, the documen - [License](https://github.com/vantagedesign/ace-documentation/blob/master/LICENSE.md) + ## Reporting Issues We use GitHub Issues as the official bug tracker for the Ace documentation. When reporting an issue, please follow the following guidelines: @@ -51,11 +53,22 @@ We use GitHub Issues as the official bug tracker for the Ace documentation. When 3. Specify your browser and version of Ace. + +## Contributing to Ace + +Contributions are highly appreciated and may be done by reporting issues with new feature suggestions or bug fixes, or by making pull requests. We'll try our best to get those sorted as soon as possible. + +Please make pull requests to the [dev branch](https://github.com/vantagedesign/ace-documentation/tree/dev). Make sure you're always running the latest version of Ace and that you are not commiting breaking changes. + + + ## Licensing - Copyright 2020 [Vantage Design](https://vantage-design.com) - Licensed under MIT (https://github.com/vantagedesign/ace-documentation/blob/master/LICENSE.md) + + ## Useful links - [More products](https://vantage-design.com) -- cgit v1.2.3 From e71324bba7b85db0a617468fff9112a29f0a72ba Mon Sep 17 00:00:00 2001 From: Julian Date: Mon, 11 May 2020 21:26:37 +0200 Subject: Added documentation for config options --- exampleSite/content/configuration/_index.md | 20 ++++++++++++++++++++ exampleSite/content/shortcodes/_index.md | 2 +- 2 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 exampleSite/content/configuration/_index.md diff --git a/exampleSite/content/configuration/_index.md b/exampleSite/content/configuration/_index.md new file mode 100644 index 0000000..54665a3 --- /dev/null +++ b/exampleSite/content/configuration/_index.md @@ -0,0 +1,20 @@ ++++ +title = "Configuration" +description = "" +weight = 2 ++++ + +{{< lead >}} +Customize and tweak Ace using a number of configuration options. +{{< /lead >}} + +## 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 config.toml or the frontmatter (a page's markdown file) for a page-wide or page-specific disabling of the ToC respectively. + 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 >}} -- cgit v1.2.3 From fef8d9978c2418740faab19e7a34951068ac4838 Mon Sep 17 00:00:00 2001 From: Julian Date: Mon, 11 May 2020 21:45:13 +0200 Subject: Allow disabling read more nav and extended config docs --- exampleSite/content/configuration/_index.md | 23 +++++++++++++++++++++++ layouts/_default/baseof.html | 4 ++-- layouts/partials/next-prev-page.html | 15 +++++++-------- 3 files changed, 32 insertions(+), 10 deletions(-) diff --git a/exampleSite/content/configuration/_index.md b/exampleSite/content/configuration/_index.md index 54665a3..dd05a47 100644 --- a/exampleSite/content/configuration/_index.md +++ b/exampleSite/content/configuration/_index.md @@ -8,6 +8,12 @@ weight = 2 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 frontmatter. This is set in config.toml, using orderSectionsby = "weight". Change this to "title" 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: @@ -18,3 +24,20 @@ toc = false in the config.toml or the frontmatter (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 config.toml file, at: +{{< code >}} +googleAnalytics = "XX-XXXXXXXXX-X" +{{< /code >}} +Where XX-XXXXXXXXX-X is your tracking ID. + + +## Read more navigation + +In config.toml or a page's frontmatter, set disableReadmoreNav = true to disable the prev/next buttons at the buttom of every page. + + +## Search + +Disable search by setting disableSearch = true in config.toml. \ No newline at end of file diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html index 1b905af..6db8cae 100644 --- a/layouts/_default/baseof.html +++ b/layouts/_default/baseof.html @@ -24,11 +24,11 @@ {{- block "main" . }}{{- end }}
- + {{- if and (ne .Site.Params.disableReadmoreNav true) (ne .Params.disableReadmoreNav true) -}}
{{ partial "next-prev-page.html" . }}
- + {{- end -}}
diff --git a/layouts/partials/next-prev-page.html b/layouts/partials/next-prev-page.html index 5a84b3a..ae0f548 100644 --- a/layouts/partials/next-prev-page.html +++ b/layouts/partials/next-prev-page.html @@ -36,13 +36,12 @@ {{- end -}}
- {{- if not $.Site.Params.disableNavChevron -}} - {{- with ($.Scratch.Get "prevPage") -}} - {{.Title}} - {{ end -}} - {{- with ($.Scratch.Get "nextPage") -}} - {{.Title}} - {{- end }} - {{- end -}} + {{- with ($.Scratch.Get "prevPage") -}} + {{.Title}} + {{ end -}} + {{- with ($.Scratch.Get "nextPage") -}} + {{.Title}} + {{- end }}
+ -- cgit v1.2.3 From 9073616c736fc95709ebc0dab3556e1f235e8b87 Mon Sep 17 00:00:00 2001 From: Julian Date: Mon, 11 May 2020 21:51:35 +0200 Subject: Updated config & changelog --- CHANGELOG.md | 4 +++- exampleSite/config.toml | 8 ++++++-- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ae89172..b0f0b71 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,11 +1,13 @@ ## Version 1.0.3 + - [FIX] Typo in readme, added changelog, updated config.toml in exampleSite - [FIX] Remove source map imports from JS files ([@jhollowe, PR #8](https://github.com/vantagedesign/ace-documentation/pull/8)) - [FIX] Fix minifier error with spacing in next-prev-page ([@jhollowe, PR #6](https://github.com/vantagedesign/ace-documentation/pull/6)) - [ADD] Allow disabling the TOC ([@jhollowe, PR #9](https://github.com/vantagedesign/ace-documentation/pull/9)) - [ADD] Allow Google Analytics to only track production site ([@jhollowe, PR #7](https://github.com/vantagedesign/ace-documentation/pull/7)) - [FIX] Prevent empty heaver toggler ([@jhollowe, PR #3](https://github.com/vantagedesign/ace-documentation/pull/3)) - [ADD] New table shortcode for styled tables (fixes [issue #2](https://github.com/vantagedesign/ace-documentation/issues/2)) - - [FIX] Typo in readme + - [ADD] Allow disabling the Read more navigation per page or for the entire site using the config (implements [issue #10](https://github.com/vantagedesign/ace-documentation/issues/10)) + - [ADD] Documentation for various config options, such as disabling toc, readmore, analytics and search. ## Version 1.0.2 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 = "" url = "https://github.com/vantagedesign/ace-documentation" -weight = 10 +weight = 2 +[[menu.shortcuts]] +name = "" +url = "https://github.com/vantagedesign/ace-documentation/releases" +weight = 3 \ No newline at end of file -- cgit v1.2.3