diff options
author | thingsym <thingsym@gmail.com> | 2020-04-01 10:57:11 +0300 |
---|---|---|
committer | thingsym <thingsym@gmail.com> | 2020-04-01 10:57:11 +0300 |
commit | 284f9b84f395428123481ae346f3d7f3c26da713 (patch) | |
tree | 3d00cf1a0e1501b439fa3e5cd99a5a62bf4e73c1 /exampleSite | |
parent | 52d4bd84e76125fef44d4b558ee6e8dac6b11423 (diff) |
docs: update sample document
Diffstat (limited to 'exampleSite')
-rw-r--r-- | exampleSite/content/getting-started/configuration.md | 39 | ||||
-rw-r--r-- | exampleSite/content/sample/custom-shortcodes.md | 9 | ||||
-rw-r--r-- | exampleSite/content/sample/search-shortcode.md | 13 |
3 files changed, 59 insertions, 2 deletions
diff --git a/exampleSite/content/getting-started/configuration.md b/exampleSite/content/getting-started/configuration.md index 9eb6679..65f6f5c 100644 --- a/exampleSite/content/getting-started/configuration.md +++ b/exampleSite/content/getting-started/configuration.md @@ -12,7 +12,7 @@ For an example of `config.toml`, see [config.toml](https://github.com/thingsym/h ## Params - # Souce Code repository section + # Source Code repository section description = "put your description" github_repository = "https://github.com/thingsym/hugo-theme-techdoc" version = "0.8.3" @@ -27,6 +27,7 @@ For an example of `config.toml`, see [config.toml](https://github.com/thingsym/h google_site_verification = "" # Your Google Site Verification for Search Console # Open Graph and Twitter Cards settings section + # Open Graph settings for each page are set on the front matter. # See https://gohugo.io/templates/internal/#open-graph # See https://gohugo.io/templates/internal/#twitter-cards title = "Hugo Techdoc Theme" @@ -53,9 +54,16 @@ For an example of `config.toml`, see [config.toml](https://github.com/thingsym/h "blog", "entry", "post", - "posts" + "posts", ] + # Algolia site search section + # See https://www.algolia.com/doc/ + algolia_search_enable = true + algolia_indexName = "hugo-demo-techdoc" + algolia_appId = "7W4SAN4PLK" + algolia_apiKey = "cbf12a63ff72d9c5dc0c10c195cf9128" # Search-Only API Key + #### `description` The document summary @@ -158,3 +166,30 @@ default: `[ "post", "posts" ]` + + +#### `algolia_search_enable` + +Enable Algolia search + +default: `true` + +value: `true` | `false` + +#### `algolia_indexName` + +Algolia index name + +default: `hugo-demo-techdoc` + +#### `algolia_appId` + +Application id + +default: `7W4SAN4PLK` + +#### `algolia_apiKey` + +Search-Only API Key + +default: `cbf12a63ff72d9c5dc0c10c195cf9128` diff --git a/exampleSite/content/sample/custom-shortcodes.md b/exampleSite/content/sample/custom-shortcodes.md index 0fb2a0a..351096d 100644 --- a/exampleSite/content/sample/custom-shortcodes.md +++ b/exampleSite/content/sample/custom-shortcodes.md @@ -18,6 +18,15 @@ description: "calling custom Shortcodes into your content files." <strong>Lorem ipsum dolor sit amet</strong>, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. <a href="https://github.com/thingsym/hugo-theme-techdoc">Ut enim ad minim venia</a>, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. {{< /panel >}} +### Alert panel using Markdown (use the `%` character) + +{{% panel title="primary" %}} +[I'm an inline-style link with title](https://www.google.com "Google's Homepage") + +- One +- Two +- Three +{{% /panel %}} ### Alert panel with titles and colors diff --git a/exampleSite/content/sample/search-shortcode.md b/exampleSite/content/sample/search-shortcode.md new file mode 100644 index 0000000..877edcb --- /dev/null +++ b/exampleSite/content/sample/search-shortcode.md @@ -0,0 +1,13 @@ +--- +title: "Search Shortcode" +date: 2020-03-30T18:49:06Z +showPagination: false +--- + +{{% panel status="primary" title="Note" icon="far fa-lightbulb" %}} +Search Shortcode powered by [Algolia](https://www.algolia.com/) + +You can create a search page just by adding `search` shortcode. +{{% /panel %}} + +{{< search >}}{{< /search >}} |