Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

User guide: adding instructions on how to use and update docsy as hugo module #802

Merged
merged 37 commits into from
Apr 4, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
cad8bfd
User guide: adding instructions on how to use and update docsy as hug…
deining Dec 10, 2021
49071eb
Add section on how to work around a known bug in Go's module management
deining Dec 18, 2021
f9ab3da
Docu for conversion of existing site: improvements and fixes
deining Jan 15, 2022
444c3f4
User guide: reflect latest changes in hugo module implementation
deining Jan 30, 2022
9f7000e
Add warning about order of sections [language] and [module] in config…
deining Feb 2, 2022
e544e54
Update docu to reflect changes made in e444964a013.
deining Feb 6, 2022
3c30707
Update _index.md
LisaFC Mar 30, 2022
38d8ce5
Update _index.md
LisaFC Mar 30, 2022
72b08cd
Update installation-prerequisites.md
LisaFC Mar 30, 2022
97147bd
Update _index.md
LisaFC Mar 30, 2022
110f7c3
Update example-site-as-template.md
LisaFC Mar 30, 2022
042dd7b
Update start-from-scratch.md
LisaFC Mar 30, 2022
53630b8
Update start-from-scratch.md
LisaFC Mar 30, 2022
9d257dc
Update and rename quickstart-clone-git-repo.md to docsy-as-submodule
LisaFC Mar 30, 2022
38d503b
Update _index.md
LisaFC Mar 30, 2022
6e5384f
Update start-from-scratch.md
LisaFC Mar 30, 2022
4635197
Rename docsy-as-submodule to other-options
LisaFC Mar 30, 2022
c97a1b8
Rename other-options to other-options.md
LisaFC Mar 30, 2022
70e29c2
Create basic-configuration.md
LisaFC Mar 31, 2022
a61f806
Update example-site-as-template.md
LisaFC Mar 31, 2022
2e69234
Update start-from-scratch.md
LisaFC Mar 31, 2022
b905bf6
Update other-options.md
LisaFC Mar 31, 2022
821cc77
Update basic-configuration.md
LisaFC Mar 31, 2022
a307f43
Update quickstart-docker.md
LisaFC Mar 31, 2022
1ba2aff
Update _index.md
LisaFC Mar 31, 2022
247c28e
Update Updating-hugo-module.md
LisaFC Mar 31, 2022
d6f5480
Update _index.md
LisaFC Mar 31, 2022
68867ca
Update Updating-submodules.md
LisaFC Mar 31, 2022
c741238
Update _index.md
LisaFC Mar 31, 2022
091485c
Update Convert-site-to-module.md
LisaFC Mar 31, 2022
ef11399
Update Updating-submodules.md
LisaFC Mar 31, 2022
4bab4b5
Update Updating-submodules.md
LisaFC Mar 31, 2022
6c49bca
Correct links to pre-release version 0.2.0-pre
deining Mar 31, 2022
a24f1b2
Netlify: correcting go version
deining Apr 1, 2022
98ee405
Compactify menu
LisaFC Apr 1, 2022
f96edf2
Fixed broken link to setup guide
LisaFC Apr 1, 2022
71641a4
User guide, .gitignore: remove unneeded entry
deining Apr 3, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ publish = "userguide/public"
command = "npm run docs-install && npm run build:preview"

[build.environment]
GO_VERSION = "1.17.7"
GO_VERSION = "1.18"
HUGO_THEME = "repo"

[context.production]
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@
"bootstrap": "^4.6.1"
},
"devDependencies": {
"hugo-extended": "0.93.2"
"hugo-extended": "0.96.0"
}
}
2 changes: 1 addition & 1 deletion userguide/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ prism_syntax_highlighting = false
# User interface configuration
[params.ui]
# Enable to show the side bar menu in its compact state.
sidebar_menu_compact = false
sidebar_menu_compact = true
sidebar_menu_foldable = false
sidebar_cache_limit = 10
# Set to true to disable breadcrumb navigation.
Expand Down
6 changes: 3 additions & 3 deletions userguide/content/en/docs/Adding content/Shortcodes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -361,7 +361,7 @@ Karibu sana!

Tabbed panes are implemented using two shortcodes:

* The `tabpane` shortcode, which is the container element for the tabs. This shortcode can optionally held the named parameters `lang` and/or `highlight`. The values of these optional parameters are passed on as second `LANG` and third `OPTIONS` arguments to Hugo's built-in [`highlight`](https://gohugo.io/functions/highlight/) function which is used to render the code blocks of the individual tabs. In case the header text of the tab equals the `language` used in the tab's code block (as in the first tabbed pane example above), you may specify `langEqualsHeader=true` in the surrounding `tabpane` shortcode. Then, the header text of the individual tab is automatically set as `language` parameter of the respective tab.
* The `tabpane` shortcode, which is the container element for the tabs. This shortcode can optionally hold the named parameters `lang` and/or `highlight`. The values of these optional parameters are passed on as second `LANG` and third `OPTIONS` arguments to Hugo's built-in [`highlight`](https://gohugo.io/functions/highlight/) function which is used to render the code blocks of the individual tabs. In case the header text of the tab equals the `language` used in the tab's code block (as in the first tabbed pane example above), you may specify `langEqualsHeader=true` in the surrounding `tabpane` shortcode. Then, the header text of the individual tab is automatically set as `language` parameter of the respective tab.
* The various `tab` shortcodes which actually represent the tabs you would like to show. We recommend specifying the named parameter `header` for each text in order to set the header text of each tab. If needed, you can additionally specify the named parameters `lang` and `highlight` for each tab. This allows you to overwrite the settings given in the parent `tabpane` shortcode. If the language is neither specified in the `tabpane` nor in the `tab`shortcode, it defaults to Hugo's site variable `.Site.Language.Lang`.

## Card panes
Expand All @@ -386,7 +386,7 @@ When authoring content, it's sometimes very useful to put similar text blocks or
Docsy supports creating such card panes via different shortcodes:

* The `cardpane` shortcode which is the container element for the various cards to be presented.
* The `card` shortcodes, with each shortcode representing an individual card. While cards are often presented inside a card group, a single card may stand on its own, too. A `card` shortcode can held text, images or any other arbitrary kind of markdown or HTML markup as content. If your content is programming code, you are advised to make use of the `card-code` shortcode, a special kind of card with code-highlighting and other optional features like line numbers, highlighting of certain lines, ….
* The `card` shortcodes, with each shortcode representing an individual card. While cards are often presented inside a card group, a single card may stand on its own, too. A `card` shortcode can hold text, images or any other arbitrary kind of markdown or HTML markup as content. If your content is programming code, you are advised to make use of the `card-code` shortcode, a special kind of card with code-highlighting and other optional features like line numbers, highlighting of certain lines, ….

### Shortcode `card` (for text, images, …)

Expand Down Expand Up @@ -459,7 +459,7 @@ int main(void)
}
{{< /card-code >}}

<br/>The `card-code` shortcode can optionally held the named parameters `lang` and/or `highlight`. The values of these optional parameters are passed on as second `LANG` and third `OPTIONS` arguments to Hugo's built-in [`highlight`](https://gohugo.io/functions/highlight/) function which is used to render the code block presented on the card.
<br/>The `card-code` shortcode can optionally hold the named parameters `lang` and/or `highlight`. The values of these optional parameters are passed on as second `LANG` and third `OPTIONS` arguments to Hugo's built-in [`highlight`](https://gohugo.io/functions/highlight/) function which is used to render the code block presented on the card.

### Card groups

Expand Down
2 changes: 1 addition & 1 deletion userguide/content/en/docs/Deployment/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Then follow the instructions in [Host on Netlify](https://gohugo.io/hosting-and-
1. For your **Build command**, specify `cd themes/docsy && git submodule update -f --init && cd ../.. && hugo`. You need to specify this rather than just `hugo` so that Netlify can use the theme's submodules. If you don't want your site to be indexed by search engines, you can add an environment flag to specify a non-`production` environment, as described in [Build environments and indexing](#build-environments-and-indexing).
1. Click **Show advanced**.
1. In the **Advanced build settings** section, click **New variable**.
1. Specify `HUGO_VERSION` as the **Key** for the new variable, and `0.53` or later as its **Value**.
1. Specify `HUGO_VERSION` as the **Key** for the new variable, and `0.73` or later as its **Value**.
1. Click **Deploy site**.

{{% alert title="Note" color="primary" %}}
Expand Down
Loading