Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/vantagedesign/ace-documentation.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--README.md6
-rw-r--r--assets/css/ace.scss240
-rw-r--r--exampleSite/content/_index.md2
-rw-r--r--exampleSite/content/configuration/_index.md17
-rw-r--r--exampleSite/content/getting-started/_index.md4
-rw-r--r--exampleSite/content/getting-started/installation.md4
-rw-r--r--exampleSite/content/getting-started/usage.md18
-rw-r--r--exampleSite/content/shortcodes/alerts.md15
-rw-r--r--exampleSite/content/shortcodes/buttons.md24
-rw-r--r--exampleSite/content/shortcodes/childpages.md4
-rw-r--r--exampleSite/content/shortcodes/code.md12
-rw-r--r--exampleSite/content/shortcodes/collapse.md2
-rw-r--r--exampleSite/content/shortcodes/doublecode.md10
-rw-r--r--exampleSite/content/shortcodes/panel.md18
-rw-r--r--exampleSite/content/shortcodes/table.md12
-rw-r--r--layouts/index.json6
-rw-r--r--layouts/partials/header.html3
-rw-r--r--static/plugins/search.js21
18 files changed, 221 insertions, 197 deletions
diff --git a/README.md b/README.md
index 5be63c3..ac91aab 100644
--- a/README.md
+++ b/README.md
@@ -58,7 +58,7 @@ We use GitHub Issues as the official bug tracker for the Ace documentation. When
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.
+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 committing breaking changes.
@@ -74,11 +74,11 @@ Please make pull requests to the [dev branch](https://github.com/vantagedesign/a
- [More products](https://vantage-design.com)
- [Free products](https://vantage-design.com/products/free-products/)
- [Premium products](https://vantage-design.com/products/premium-products/)
-- [Design sytems](https://vantage-design.com/products/design-systems/)
+- [Design systems](https://vantage-design.com/products/design-systems/)
- [Page templates](https://vantage-design.com/products/page-templates/)
- [Documentation themes](https://vantage-design.com/products/documentation-themes/)
### Social Media
- Facebook: <https://www.facebook.com/vantagedesignofficial>
-- Instagram: <https://www.instagram.com/vantagedesignofficial> \ No newline at end of file
+- Instagram: <https://www.instagram.com/vantagedesignofficial>
diff --git a/assets/css/ace.scss b/assets/css/ace.scss
index f9490be..ad300a0 100644
--- a/assets/css/ace.scss
+++ b/assets/css/ace.scss
@@ -1,121 +1,121 @@
-/* -------------------------------------------------------------------------
-* ACE DOCUMENTATION
-* Stylesheet
-* @author Vantage Design
-* @version 1.0.4
-* @license https://github.com/vantagedesign/ace-documentation/blob/master/LICENSE
-* ------------------------------------------------------------------------ */
-
-$primary: #007bff;
-$secondary: #6610f2;
-$success: #28a745;
-$info: #17a2b8;
-$warning: #ffc107;
-$danger: #dc3545;
-$light: #f8f9fa;
-$dark: #343a40;
-
-@import "bootstrap/bootstrap";
-
-/* Typography styling */
-.main > h1{
- padding-top: 2rem;
-}
-
-.main > h2{
- padding-top: 4rem;
- margin-top:-1rem;
-}
-
-.main > h3, .main > h4, .main > h5, .main > h6{
- padding-top: 4rem;
- margin-top:-3rem;
-}
-
-.haschildren ul{
- color: gray;
- display:none;
-}
-
-.haschildren.active ul, .haschildren.parent ul{
- display:block;
-}
-
-.highlight > pre {
- padding:15px;
-}
-
-
-/* Side navigation menus */
-.docs-sidenav span.badge.badge-primary, .docs-toc span.badge.badge-primary{
- font-size: 10px;
-}
-
-@media (min-width: 768px) {
- .docs-sidenav, .docs-toc{
- height: calc(100vh - 4rem);
- top:4rem;
- position: sticky;
- overflow: auto;
- }
- .docs-sidenav .navbar, .docs-toc .navbar{
- padding-right: 0;
- }
- .docs-sidenav .navbar-collapse, .docs-sidenav .navbar-nav{
- width: 100%;
- }
- .docs-sidenav .nav-link, .docs-toc li a{
- display: flex;
- align-items: start;
- justify-content: space-between;
- }
- .docs-sidenav .nav-link > span.badge.badge-primary, .docs-toc li a > span.badge.badge-primary{
- margin-top: 5px;
- }
-}
-
-@media (min-width: 1200px) {
- .docs-toc.large{
- height: calc(100vh - 4rem);
- }
-}
-
-@media (max-width: 1200px) {
- .docs-toc.large{
- display:none;
- }
-}
-
-.docs-toc{
- padding-top: 10px;
-}
-
-.docs-toc a{
- font-size: 14px;
- color: gray;
-}
-
-.docs-toc a:hover{
- color: #333;
-}
-
-.docs-toc ul{
- list-style: none;
- padding-left:8px;
- margin-top:3px;
-}
-
-.docs-toc ul:first-child{
- padding-left:0;
-}
-
-/* Table tweak for JavaScript methods */
-table td:first-child > code{
- word-break: normal;
-}
-
-table > tbody > tr > td, .bd-content > table > tbody > tr > th, .bd-content > table > tfoot > tr > td, .bd-content > table > tfoot > tr > th, .bd-content > table > thead > tr > td, .bd-content > table > thead > tr > th {
- padding: .75rem;
- vertical-align: top;
- border: 1px solid #dee2e6;
+/* -------------------------------------------------------------------------
+* ACE DOCUMENTATION
+* Stylesheet
+* @author Vantage Design
+* @version 1.0.4
+* @license https://github.com/vantagedesign/ace-documentation/blob/master/LICENSE
+* ------------------------------------------------------------------------ */
+
+$primary: #007bff;
+$secondary: #6610f2;
+$success: #28a745;
+$info: #17a2b8;
+$warning: #ffc107;
+$danger: #dc3545;
+$light: #f8f9fa;
+$dark: #343a40;
+
+@import "bootstrap/bootstrap";
+
+/* Typography styling */
+.main > h1{
+ padding-top: 2rem;
+}
+
+.main > h2{
+ padding-top: 4rem;
+ margin-top:-1rem;
+}
+
+.main > h3, .main > h4, .main > h5, .main > h6{
+ padding-top: 4rem;
+ margin-top:-3rem;
+}
+
+.haschildren ul{
+ color: gray;
+ display:none;
+}
+
+.haschildren.active ul, .haschildren.parent ul{
+ display:block;
+}
+
+.highlight > pre {
+ padding:15px;
+}
+
+
+/* Side navigation menus */
+.docs-sidenav span.badge.badge-primary, .docs-toc span.badge.badge-primary{
+ font-size: 10px;
+}
+
+@media (min-width: 768px) {
+ .docs-sidenav, .docs-toc{
+ height: calc(100vh - 4rem);
+ top:4rem;
+ position: sticky;
+ overflow: auto;
+ }
+ .docs-sidenav .navbar, .docs-toc .navbar{
+ padding-right: 0;
+ }
+ .docs-sidenav .navbar-collapse, .docs-sidenav .navbar-nav{
+ width: 100%;
+ }
+ .docs-sidenav .nav-link, .docs-toc li a{
+ display: flex;
+ align-items: start;
+ justify-content: space-between;
+ }
+ .docs-sidenav .nav-link > span.badge.badge-primary, .docs-toc li a > span.badge.badge-primary{
+ margin-top: 5px;
+ }
+}
+
+@media (min-width: 1200px) {
+ .docs-toc.large{
+ height: calc(100vh - 4rem);
+ }
+}
+
+@media (max-width: 1200px) {
+ .docs-toc.large{
+ display:none;
+ }
+}
+
+.docs-toc{
+ padding-top: 10px;
+}
+
+.docs-toc a{
+ font-size: 14px;
+ color: gray;
+}
+
+.docs-toc a:hover{
+ color: #333;
+}
+
+.docs-toc ul{
+ list-style: none;
+ padding-left:8px;
+ margin-top:3px;
+}
+
+.docs-toc ul:first-child{
+ padding-left:0;
+}
+
+/* Table tweak for JavaScript methods */
+table td:first-child > code{
+ word-break: normal;
+}
+
+table > tbody > tr > td, .bd-content > table > tbody > tr > th, .bd-content > table > tfoot > tr > td, .bd-content > table > tfoot > tr > th, .bd-content > table > thead > tr > td, .bd-content > table > thead > tr > th {
+ padding: .75rem;
+ vertical-align: top;
+ border: 1px solid #dee2e6;
} \ No newline at end of file
diff --git a/exampleSite/content/_index.md b/exampleSite/content/_index.md
index 8e53359..c58dda1 100644
--- a/exampleSite/content/_index.md
+++ b/exampleSite/content/_index.md
@@ -92,7 +92,7 @@ Ace is a theme for <a href="https://gohugo.io" target="_blank">Hugo</a>, a fast
</div>
<div class="card-body pl-2">
<h5 class="card-title">
- Code hightlighting.
+ Code highlighting.
</h5>
<p class="card-text text-muted">
Code highlighting. Include code samples with a copy button. If it’s HTML, you can also render the code.
diff --git a/exampleSite/content/configuration/_index.md b/exampleSite/content/configuration/_index.md
index dd05a47..244df9b 100644
--- a/exampleSite/content/configuration/_index.md
+++ b/exampleSite/content/configuration/_index.md
@@ -24,6 +24,16 @@ toc = false
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.
+
+## Logo
+
+An optional site logo can be specified:
+
+{{< code >}}
+site_logo = /logo.svg
+{{< /code >}}
+
+
## Google Analytics
Enable Google Analytics by adding your GA tracking ID to the <code>config.toml</code> file, at:
@@ -35,9 +45,12 @@ 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.
+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 bottom of every page.
## Search
-Disable search by setting <code>disableSearch = true</code> in <code>config.toml</code>. \ No newline at end of file
+Disable search by setting <code>disableSearch = true</code> in <code>config.toml</code>.
+
+The local search feature is based on the content of `index.json`, which is generated based on a configurable template.
+Search results are presented as a drop-down list attached to the search input field while typing.
diff --git a/exampleSite/content/getting-started/_index.md b/exampleSite/content/getting-started/_index.md
index db293bd..b91ff7b 100644
--- a/exampleSite/content/getting-started/_index.md
+++ b/exampleSite/content/getting-started/_index.md
@@ -5,10 +5,10 @@ weight = 1
+++
{{< lead >}}
-Get started with Ace docs, the easy way to generate a static website for your project's documentation.
+Get started with Ace docs, the easy way to generate a static website for your project's documentation.
{{< /lead >}}
Installation and configuration is easy and can be easily applied to any project. No need to be dependent on Python, Ruby or Java. Hugo runs from a simple binary and works through the command line.
Explore the following pages to learn how to build awesome documentation for your project using Ace.
-{{< childpages >}} \ No newline at end of file
+{{< childpages >}}
diff --git a/exampleSite/content/getting-started/installation.md b/exampleSite/content/getting-started/installation.md
index a945dcb..cb547b0 100644
--- a/exampleSite/content/getting-started/installation.md
+++ b/exampleSite/content/getting-started/installation.md
@@ -5,13 +5,13 @@ weight = 1
+++
{{< lead >}}
-Installing Ace is easy. Just install the Hugo binary, create a new site and install the Ace theme.
+Installing Ace is easy. Just install the Hugo binary, create a new site and install the Ace theme.
{{< /lead >}}
## Installing Hugo
In order to run this theme, you need to install Hugo on your system.
This theme requires Hugo's extended version to support SCSS compilation, so make please sure you install the extended version.
-For more detailed information and other methods of installation you can visit the <a href="https://gohugo.io/getting-started/installing/" target="_blank">Hugo installation guide.</a>
+For more detailed information and other methods of installation you can visit the <a href="https://gohugo.io/getting-started/installing/" target="_blank">Hugo installation guide</a>.
There may be other ways to install Hugo that are more applicable for your project. For example, you can use the NPM package <a href="https://www.npmjs.com/package/hugo-bin" target="_blank">hugo-bin</a> to include Hugo in a project that already uses NPM packages.
diff --git a/exampleSite/content/getting-started/usage.md b/exampleSite/content/getting-started/usage.md
index 53b2539..a4cdbbd 100644
--- a/exampleSite/content/getting-started/usage.md
+++ b/exampleSite/content/getting-started/usage.md
@@ -32,7 +32,7 @@ hugo
Pages are written in Markdown and files defining pages should end with *.md*. For more information on how to use Markdown, search for tutorials on the internet or use this <a href="https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet" target="_blank">cheatsheet</a>.
### File structure
-Ace looks at your file stucture and automatically turns it into a menu.
+Ace looks at your file structure and automatically turns it into a menu.
The structure looks as follows:
{{< code >}}
/content
@@ -53,10 +53,10 @@ The structure looks as follows:
└── /level-four
├── page-4-one.md
└── page-4-two.md
-{{< /code >}}
+{{< /code >}}
+
+Your 'homepage' for every level is the <code>_index.md</code> file. Subpages (like <code>page-1-one.md</code>) are automatically added as child pages in the menu.
-Your 'homepage' for every level is the <code>_index.md</code> file. Subpages (like <code>page-1-one.md</code>) are automatically added as child pages in the menu.
-
An exception exists for the top level files. <code>/content/_index.md</code> is your homepage, and any other page files in the <code>/content</code> folder are not automatically added in the menu. Instead, they can be accessed manually through their URL (<code>yourdomain.com/page-title</code>).
### File contents
@@ -67,10 +67,10 @@ title = "Usage"
description = ""
weight = 2
+++
-{{< /code >}}
-The title will be displayed as a H1 header at the top of your page. The weight determines the order in the menu.
-
-After that you may write the content you desire with Markdown. You may use shortcodes to add some more 'advanced' layout features to the page, such as code hightlighting, a 'lead' style paragraph, images, video's, and more.
+{{< /code >}}
+The title will be displayed as a H1 header at the top of your page. The weight determines the order in the menu.
+
+After that you may write the content you desire with Markdown. You may use shortcodes to add some more 'advanced' layout features to the page, such as code highlighting, a 'lead' style paragraph, images, video's, and more.
### Navigation bar menu
While the left sidebar navigation is automatically populated by the file structure described above, and the right 'table of contents' sidebar menu is automatically populated by the headings defined on a page, the top navigation bar needs to be configured manually.
@@ -83,4 +83,4 @@ url = "https://github.com/vantagedesign/ace-documentation"
weight = 10
{{< /code >}}
-This example will create a GitHub icon that links to that URL. Instead of an icon, you may also use text, or both. \ No newline at end of file
+This example will create a GitHub icon that links to that URL. Instead of an icon, you may also use text, or both.
diff --git a/exampleSite/content/shortcodes/alerts.md b/exampleSite/content/shortcodes/alerts.md
index 8673457..ed7f31d 100644
--- a/exampleSite/content/shortcodes/alerts.md
+++ b/exampleSite/content/shortcodes/alerts.md
@@ -4,7 +4,7 @@ description = ""
weight = 1
+++
-The alerts shortcode allows you to let information stand out by means of an alert styled box. This can be used to indicate danger, warning, success or info.
+The alerts shortcode allows you to let information stand out by means of an alert styled box. This can be used to indicate danger, warning, success or info.
{{< alert style="danger" >}} I'm a danger alert {{< /alert >}}
{{< alert style="warning" >}} I'm a warning alert {{< /alert >}}
@@ -13,15 +13,14 @@ The alerts shortcode allows you to let information stand out by means of an aler
## Usage
Place the following shortcode on the page
-{{< code lang="html" >}}
+{{< code lang="html" >}}
{{</* alert style="STYLE" */>}} [content] {{</* /alert */>}}
{{< /code >}}
### Parameters
#### Style
-The style parameter is directly applied to the alert as a class in the format *"alert-{STYLE}"*. Bootstrap comes with four styles that can be used with this:
-- danger
-- warning
-- success
-- info
-
+The style parameter is directly applied to the alert as a class in the format *"alert-{STYLE}"*. Bootstrap comes with four styles that can be used with this:
+- danger
+- warning
+- success
+- info
diff --git a/exampleSite/content/shortcodes/buttons.md b/exampleSite/content/shortcodes/buttons.md
index 5d3a462..a539f5c 100644
--- a/exampleSite/content/shortcodes/buttons.md
+++ b/exampleSite/content/shortcodes/buttons.md
@@ -4,7 +4,7 @@ description = ""
weight = 2
+++
-The button shortcode allows you to add a button to the page. This button is a HTML *anchor* element and can thus be used to link to another page or website.
+The button shortcode allows you to add a button to the page. This button is a HTML *anchor* element and can thus be used to link to another page or website.
{{< button style="primary" >}} Button {{< /button >}}
{{< button style="secondary" >}} Button {{< /button >}}
@@ -16,23 +16,23 @@ The button shortcode allows you to add a button to the page. This button is a HT
## Usage
Place the following shortcode on the page
-{{< code lang="html" >}}
+{{< code lang="html" >}}
{{</* button style="STYLE" link="https://yourwebsite.com" */>}} [content] {{</* /button */>}}
{{< /code >}}
### Parameters
#### *style*
-The style parameter is directly applied to the alert as a class in the format *"btn-{STYLE}"*. Bootstrap comes with a variety of styles that can be used with this:
-- primary
-- secondary
-- danger
-- warning
-- success
-- info
+The style parameter is directly applied to the alert as a class in the format *"btn-{STYLE}"*. Bootstrap comes with a variety of styles that can be used with this:
+- primary
+- secondary
+- danger
+- warning
+- success
+- info
-Each style can also be presented as an 'outline' variant by prefixing the style with 'outline-'.
+Each style can also be presented as an 'outline' variant by prefixing the style with 'outline-'.
Example: <code>style="outline-primary"</code>.
#### *link*
-The link parameter may consist of an URL leading to a page or other website. Simply use it by defining a URL for the button to link to.
-Example: <code>link="https://google.com"</code>. \ No newline at end of file
+The link parameter may consist of an URL leading to a page or other website. Simply use it by defining a URL for the button to link to.
+Example: <code>link="https://google.com"</code>.
diff --git a/exampleSite/content/shortcodes/childpages.md b/exampleSite/content/shortcodes/childpages.md
index e789272..8fca57a 100644
--- a/exampleSite/content/shortcodes/childpages.md
+++ b/exampleSite/content/shortcodes/childpages.md
@@ -4,10 +4,10 @@ description = ""
weight = 3
+++
-The childpages shortcode allows you to show a list of sub-pages of the current page. For example, the *Getting started* page of this documentation has three child pages: *Installation*, *Configuration* and *Creating content*. Placing the childpages shortcode in the *Getting started* page will place a create a list of these sub-pages in that page.
+The childpages shortcode allows you to show a list of sub-pages of the current page. For example, the *Getting started* page of this documentation has three child pages: *Installation*, *Configuration* and *Creating content*. Placing the childpages shortcode in the *Getting started* page will place a create a list of these sub-pages in that page.
## Usage
Simply place the following shortcode on the page
{{< code lang="html" >}}
{{</* childpages */>}}
-{{< /code >}} \ No newline at end of file
+{{< /code >}}
diff --git a/exampleSite/content/shortcodes/code.md b/exampleSite/content/shortcodes/code.md
index c4e5797..32032b8 100644
--- a/exampleSite/content/shortcodes/code.md
+++ b/exampleSite/content/shortcodes/code.md
@@ -4,7 +4,7 @@ description = ""
weight = 4
+++
-Add code to your page with syntax highlighting and a copy button so your users can easily copy the code to their clipboard with the press of a button. The code may be entered inside the shortcode or come from an external file.
+Add code to your page with syntax highlighting and a copy button so your users can easily copy the code to their clipboard with the press of a button. The code may be entered inside the shortcode or come from an external file.
{{< code lang="html" >}}
<div class="mydiv bg-primary shadow text-white">
@@ -23,15 +23,15 @@ Simply place the following shortcode on the page
{{< code lang="html" >}}
{{</* code lang="LANG" file="code/mycode.html" */>}}
{{< /code >}}
-
+
### Parameters
#### *lang*
-The lang parameter defines the language to be used for code highlighting. You can find a complete list of supported languages <a href="https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages" target="_blank">here</a>.
-
+The lang parameter defines the language to be used for code highlighting. You can find a complete list of supported languages <a href="https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages" target="_blank">here</a>.
+
Example: <code>lang="html"</code>
#### *file*
-The file parameter allows you to define an external file that contains your code to be displayed. This is done by giving a path to that file, starting from the root directory of your site.
-For example, a HTML file named *'mycode.html'* you wish to link that is in the *docs/code/* directory can be defined as follows: <code>file="code/mycode.html"</code>. \ No newline at end of file
+The file parameter allows you to define an external file that contains your code to be displayed. This is done by giving a path to that file, starting from the root directory of your site.
+For example, a HTML file named *'mycode.html'* you wish to link that is in the *docs/code/* directory can be defined as follows: <code>file="code/mycode.html"</code>.
diff --git a/exampleSite/content/shortcodes/collapse.md b/exampleSite/content/shortcodes/collapse.md
index 4986013..eb5dc2d 100644
--- a/exampleSite/content/shortcodes/collapse.md
+++ b/exampleSite/content/shortcodes/collapse.md
@@ -19,5 +19,5 @@ Simply place the following shortcode on the page
### Parameters
#### *title*
-The lang parameter defines the text to show in the button that toggles the collapse content.
+The lang parameter defines the text to show in the button that toggles the collapse content.
Example: <code>title="Click me to show content"</code>.
diff --git a/exampleSite/content/shortcodes/doublecode.md b/exampleSite/content/shortcodes/doublecode.md
index 0b6642b..bb8232b 100644
--- a/exampleSite/content/shortcodes/doublecode.md
+++ b/exampleSite/content/shortcodes/doublecode.md
@@ -4,7 +4,7 @@ description = ""
weight = 6
+++
-The *doublecode* shortcode works the same as the [code](/shortcodes/code/) shortcode, but extends the functionality by also rendering the code in the page. This is useful for showing the code of HTML elements in your page.
+The *doublecode* shortcode works the same as the [code](/shortcodes/code/) shortcode, but extends the functionality by also rendering the code in the page. This is useful for showing the code of HTML elements in your page.
{{< doublecode lang="html" >}}
<div class="mydiv bg-primary shadow text-white p-3 m-4 border-primary">
@@ -27,10 +27,10 @@ Simply place the following shortcode on the page
### Parameters
#### *lang*
-The lang parameter defines the language to be used for code highlighting. You can find a complete list of supported languages <a href="https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages" target="_blank">here</a>.
-
+The lang parameter defines the language to be used for code highlighting. You can find a complete list of supported languages <a href="https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages" target="_blank">here</a>.
+
Example: <code>lang="html"</code>
#### *file*
-The file parameter allows you to define an external file that contains your code to be displayed. This is done by giving a path to that file, starting from the root directory of your site.
-For example, a HTML file named *'mycode.html'* you wish to link that is in the *docs/code/* directory can be defined as follows: <code>file="code/mycode.html"</code>. \ No newline at end of file
+The file parameter allows you to define an external file that contains your code to be displayed. This is done by giving a path to that file, starting from the root directory of your site.
+For example, a HTML file named *'mycode.html'* you wish to link that is in the *docs/code/* directory can be defined as follows: <code>file="code/mycode.html"</code>.
diff --git a/exampleSite/content/shortcodes/panel.md b/exampleSite/content/shortcodes/panel.md
index 9868b14..257456a 100644
--- a/exampleSite/content/shortcodes/panel.md
+++ b/exampleSite/content/shortcodes/panel.md
@@ -18,15 +18,15 @@ Simply place the following shortcode on the page
### Parameters
#### Style
-The style parameter is directly applied to the alert as a class in the format *"border-{STYLE}"*. Bootstrap comes with a variety of styles that can be used with this:
-- primary
-- secondary
-- danger
-- warning
-- success
-- info
+The style parameter is directly applied to the alert as a class in the format *"border-{STYLE}"*. Bootstrap comes with a variety of styles that can be used with this:
+- primary
+- secondary
+- danger
+- warning
+- success
+- info
Example: <code>style="danger"</code>.
#### Title
-The title paramter defines the text shown as a title in the panel. It will have the same color as the style.
-Example: <code>title="I'm important"</code>. \ No newline at end of file
+The title parameter defines the text shown as a title in the panel. It will have the same color as the style.
+Example: <code>title="I'm important"</code>.
diff --git a/exampleSite/content/shortcodes/table.md b/exampleSite/content/shortcodes/table.md
index 232c324..82f4381 100644
--- a/exampleSite/content/shortcodes/table.md
+++ b/exampleSite/content/shortcodes/table.md
@@ -15,7 +15,7 @@ The table shortcode allows you to wrap your tables in a <code>table</code> class
## Usage
Place the following shortcode on the page
-{{< code lang="html" >}}
+{{< code lang="html" >}}
{{</* table style="STYLE" */>}}
| Tables | are | cool |
| ------------- |:-------------:| -----:|
@@ -27,8 +27,8 @@ Place the following shortcode on the page
### Parameters
#### Style
-The style parameter is directly applied to the table as a class in the format *"{STYLE}"*. Bootstrap comes with several styles that can be used with this:
-- table-striped
-- table-dark
-- table-bordered
-- table-hover
+The style parameter is directly applied to the table as a class in the format *"{STYLE}"*. Bootstrap comes with several styles that can be used with this:
+- table-striped
+- table-dark
+- table-bordered
+- table-hover
diff --git a/layouts/index.json b/layouts/index.json
index 84219aa..ab313ca 100644
--- a/layouts/index.json
+++ b/layouts/index.json
@@ -3,9 +3,9 @@
{{- if and $index (gt $index 0) -}},{{- end }}
{
"uri": "{{ $page.Permalink }}",
- "title": "{{ htmlEscape $page.Title}}",
- "tags": [{{ range $tindex, $tag := $page.Params.tags }}{{ if $tindex }}, {{ end }}"{{ $tag| htmlEscape }}"{{ end }}],
- "description": "{{ htmlEscape .Description}}",
+ "title": {{ $page.Title | jsonify }},
+ "tags": {{ $page.Params.tags | jsonify }},
+ "description": {{ .Description | jsonify }},
"content": {{$page.Plain | jsonify}}
}
{{- end -}}
diff --git a/layouts/partials/header.html b/layouts/partials/header.html
index 79224ad..61e9479 100644
--- a/layouts/partials/header.html
+++ b/layouts/partials/header.html
@@ -2,6 +2,9 @@
<div class="container">
<div>
<a class="navbar-brand" href="{{ .Site.BaseURL | relLangURL }}">
+ {{ with .Site.Params.site_logo }}
+ <img src="{{ . }}" />
+ {{ end }}
{{ .Site.Title }}
</a>
</div>
diff --git a/static/plugins/search.js b/static/plugins/search.js
index 08afa15..80eed2a 100644
--- a/static/plugins/search.js
+++ b/static/plugins/search.js
@@ -5,7 +5,7 @@ function endsWith(str, suffix) {
}
// Initialize lunrjs using our generated index file
-function initLunr() {
+function initLunr(success_callback) {
if (!endsWith(baseurl,"/")){
baseurl = baseurl+'/'
};
@@ -13,10 +13,10 @@ function initLunr() {
// First retrieve the index file
$.getJSON(baseurl +"index.json")
.done(function(index) {
- pagesIndex = index;
+ pagesIndex = index;
// Set up lunrjs by declaring the fields we use
// Also provide their boost level for the ranking
- lunrIndex = new lunr.Index
+ lunrIndex = new lunr.Index;
lunrIndex.ref("uri");
lunrIndex.field('title', {
boost: 15
@@ -33,6 +33,7 @@ function initLunr() {
lunrIndex.add(page);
});
lunrIndex.pipeline.remove(lunrIndex.stemmer)
+ success_callback();
})
.fail(function(jqxhr, textStatus, error) {
var err = textStatus + ", " + error;
@@ -55,9 +56,7 @@ function search(query) {
});
}
-// Let's get started
-initLunr();
-$( document ).ready(function() {
+function configure_completion() {
var searchList = new autoComplete({
/* selector for the search box element */
selector: $("#search-by").get(0),
@@ -88,4 +87,14 @@ $( document ).ready(function() {
location.href = item.getAttribute('data-uri');
}
});
+};
+
+$( document ).ready(function() {
+ // configure lazy loading of the search database
+ $("#search-by").focusin(function() {
+ // download and initialize the index only once
+ if (typeof lunrIndex == 'undefined') {
+ initLunr(configure_completion);
+ }
+ });
});
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-18 04:54:13 +0300