github/hugo-geekdoc
0
0
Fork 0
mirror of https://github.com/thegeeklab/hugo-geekdoc.git synced 2024-11-22 04:40:40 +00:00
Code Issues Projects Releases Wiki Activity

docs: migrate hints to named attributes (#393)

Browse Source
This commit is contained in:
Robert Kaussow 2022-04-30 14:28:48 +02:00 committed by GitHub
parent 2f5054f389
commit a056805a30
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
exampleSite/content/en/_includes/include-page.md
View File

@ -1,6 +1,6 @@
_**Example page include**_ _**Example page include**_
{{< hint info >}} {{< hint type=note >}}
**Example Shortcode**\ **Example Shortcode**\
Shortcode used in an include page. Shortcode used in an include page.
{{< /hint >}} {{< /hint >}}

2
exampleSite/content/en/shortcodes/includes.md
View File

@ -27,7 +27,7 @@ Attributes:
If no other options are specified, files will be rendered as Markdown using the `RenderString` [function](https://gohugo.io/functions/renderstring/). If no other options are specified, files will be rendered as Markdown using the `RenderString` [function](https://gohugo.io/functions/renderstring/).
{{< hint warning >}} {{< hint type=important >}}
**Location of markdown files**\ **Location of markdown files**\
If you include markdown files that should not get a menu entry, place them outside the content folder or exclude them otherwise. If you include markdown files that should not get a menu entry, place them outside the content folder or exclude them otherwise.
{{< /hint >}} {{< /hint >}}

4
exampleSite/content/en/usage/getting-started.md
View File

@ -88,7 +88,7 @@ curl -L https://github.com/thegeeklab/hugo-geekdoc/releases/latest/download/hugo
### Option 2: Clone the GitHub repository ### Option 2: Clone the GitHub repository
{{< hint info >}} {{< hint type=note >}}
**Info**\ **Info**\
Keep in mind this method is not recommended and needs some extra steps to get it working. Keep in mind this method is not recommended and needs some extra steps to get it working.
If you want to use the Theme as submodule keep in mind that your build process need to If you want to use the Theme as submodule keep in mind that your build process need to
@ -164,7 +164,7 @@ command = "command1 && command 2 && command3 && hugo"
### Subdirectories ### Subdirectories
{{< hint danger >}} {{< hint type=important >}}
**Warning**\ **Warning**\
As deploying Hugo sites on subdirectories is not as robust as on subdomains, we do not recommend this. As deploying Hugo sites on subdirectories is not as robust as on subdomains, we do not recommend this.
If you have a choice, using a domain/subdomain should always be the preferred solution! If you have a choice, using a domain/subdomain should always be the preferred solution!

2
exampleSite/content/en/usage/menus.md
View File

@ -68,7 +68,7 @@ As an advantage you can add [icons](/features/icon-sets/) to your menu entries e
### More menu ### More menu
{{< hint ok >}} {{< hint type=tip >}}
**Tip**\ **Tip**\
The more menu is special type of the bundle menu and can be combined with the default file-tree menu. The more menu is special type of the bundle menu and can be combined with the default file-tree menu.
{{< /hint >}} {{< /hint >}}

1
src/sass/_asciidoc.scss
View File

@ -1,4 +1,3 @@
// {{< hint >}}
.admonitionblock { .admonitionblock {
@each $name, $color in $hint-colors { @each $name, $color in $hint-colors {
&.#{$name} { &.#{$name} {

4
src/sass/_color_mode.scss
View File

@ -90,8 +90,8 @@
--footer-link-color: #{$link-color-footer}; --footer-link-color: #{$link-color-footer};
--footer-link-color-visited: #{$link-color-footer}; --footer-link-color-visited: #{$link-color-footer};
.dark-mode-dim .gdoc-markdown { .dark-mode-dim {
img { .gdoc-markdown img {
filter: brightness(0.75) grayscale(0.2); filter: brightness(0.75) grayscale(0.2);
} }
} }