Merge branch 'dev'

CHANGELOG.md

@@ -1,11 +1,13 @@
 ## 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] Typo in readme
+ - [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))
+ - [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

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)
 
 
 
@@ -32,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)
@@ -41,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:
@@ -50,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)

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

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>. 

exampleSite/content/shortcodes/_index.md

@@ -1,7 +1,7 @@
 +++
 title = "Shortcodes"
 description = ""
-weight = 0
+weight = 3
 +++
 
 {{< lead >}}

layouts/_default/baseof.html

@@ -24,11 +24,11 @@
                     {{- block "main" . }}{{- end }}
 
                     <div class="row">
-
+                        {{- if and (ne .Site.Params.disableReadmoreNav true) (ne .Params.disableReadmoreNav true) -}}
                         <div class="position-relative mx-auto col-lg-9">
                           {{ partial "next-prev-page.html" . }}
                         </div>
-
+                        {{- end -}}
                     </div> <!-- /end of row -->
 
                 </div>

layouts/partials/next-prev-page.html

@@ -36,13 +36,12 @@ <h4 class="text-white text-center">Read more</h4>
     {{- end -}}
 
     <div class="d-flex justify-content-center">
-        {{- if not $.Site.Params.disableNavChevron -}}
-            {{- with ($.Scratch.Get "prevPage") -}}
-                <a class="p-1 mr-3 d-inline-block text-white" href="{{.RelPermalink}}" title="{{.Title}}"><i class="fas fa-chevron-left p-1"></i>{{.Title}}</a>
-            {{ end -}}
-            {{- with ($.Scratch.Get "nextPage") -}}
-                <a class="p-1 ml-3 d-inline-block text-white text-right" href="{{.RelPermalink}}" title="{{.Title}}">{{.Title}}<i class="fas fa-chevron-right p-1"></i></a>
-            {{- end }}
-        {{- end -}}
+        {{- with ($.Scratch.Get "prevPage") -}}
+            <a class="p-1 mr-3 d-inline-block text-white" href="{{.RelPermalink}}" title="{{.Title}}"><i class="fas fa-chevron-left p-1"></i>{{.Title}}</a>
+        {{ end -}}
+        {{- with ($.Scratch.Get "nextPage") -}}
+            <a class="p-1 ml-3 d-inline-block text-white text-right" href="{{.RelPermalink}}" title="{{.Title}}">{{.Title}}<i class="fas fa-chevron-right p-1"></i></a>
+        {{- end }}
     </div>
 </div>
+