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:
authorLars Kruse <devel@sumpfralle.de>2020-09-13 19:37:59 +0300
committerLars Kruse <devel@sumpfralle.de>2020-09-13 21:33:14 +0300
commit604d755b77ee6a5ad7649326d0634b4a6062e528 (patch)
tree1a7ddd2574b8450d7a5ab4ba181a41bbf4ad2c7e /exampleSite
parent9d951f6d6763bed0a7861eae798bbbc0b3488b5d (diff)
Strip superfluous whitespace
Diffstat (limited to 'exampleSite')
-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.md10
-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.md16
-rw-r--r--exampleSite/content/shortcodes/table.md12
11 files changed, 56 insertions, 57 deletions
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 a1d90c3..a4cdbbd 100644
--- a/exampleSite/content/getting-started/usage.md
+++ b/exampleSite/content/getting-started/usage.md
@@ -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,8 +67,8 @@ 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.
+{{< /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.
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 3a3a50d..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 parameter defines the text shown as a title in the panel. It will have the same color as the style.
+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