nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-22 23:37:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: announce new docs #567

Browse source
This commit is contained in:
Sören Weber 2024-10-04 12:38:36 +02:00
parent 9eec161dba
commit f81010c18b
No known key found for this signature in database
GPG key ID: BEC6D55545451B6D
2 changed files with 16 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
exampleSite/content/introduction/quickstart/_index.en.md
View file

@ -4,7 +4,7 @@ title = "Getting Started"
weight = 1
+++
Here's how to start your new website. If you're new to Hugo, we recommend learning more about it in its excellent [beginner's guide](https://gohugo.io/getting-started/).
Here's how to start your new website. If you're new to Hugo, we recommend learning more about it in its excellent [starter's guide](https://gohugo.io/getting-started/).
## Install Hugo
@ -56,7 +56,7 @@ Then add this at the end of your `hugo.toml`
### Use as a Git Submodule
If you're using [Git](https://git-scm.com/) for your project, you can start a repository now
If you're using [Git](https://git-scm.com/) for your project, you can create a repository now
````shell
git init
@ -140,6 +140,6 @@ You can upload this directory to any web server, or use one of [Hugo's many othe
Your site is now fully functional.
You can start [configuring your site](configuration) by changing options in your `hugo.toml`.
You can continue [configuring your site](configuration/) to your needs.
Page authors can also [set many page options](content) using front matter when creating content.
Or just start [writing content](content/) and learn what's possible.

17
exampleSite/content/introduction/releasenotes/7/0.en.md
View file

@ -8,9 +8,6 @@ weight = -0
## 7.0.0.beta (XXXX-XX-XX) {#7-0-0}
> [!primary]
> {{% icon fire-flame-curved %}} The release you didn't know you want! {{% icon fire-flame-curved %}}
### Hugo 0.126.0
- {{% badge color="fuchsia" icon="fa-fw fab fa-hackerrank" title=" " %}}0.126.0{{% /badge %}} This release requires a newer Hugo version.
@ -58,12 +55,22 @@ weight = -0
Care was taken, to configure the font to look similar to the previously used Work Sans. Nevertheless, in direct comparison you will see slight differences in appearance.
This change was necessary as the previously used font had display issues with [marked text](content/markdown/#marked-text), contrast and some other minor stuff.
This change was necessary as the previously used font had display issues with [marked text](content/markdown/#marked-text), contrast and some other minor stuff. As an aftermath, the number of requests and the download size were decreased when loading a page.
Although the font was created by Google, it is licensed under OFL 1.1 and is delivered from your theme's installation. As always, no third party server calls involved.
If you have overridden the font to a [variable font](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_fonts/Variable_fonts_guide#variable_fonts_what_they_are_and_how_they_differ) in your installation (either by hacking the CSS directly or by using any of the mechansims provided by the theme), you may have to adjust your CSS value for `font-variations-settings`.
If you have overridden the font to a [variable font](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_fonts/Variable_fonts_guide#variable_fonts_what_they_are_and_how_they_differ) in your installation either by hacking the CSS directly or by using any of the mechansims provided by the theme, you may have to adjust your CSS value for `font-variations-settings`. As it only applies to **variable fonts**, this should rarely be necessary.
- {{% badge style="note" title=" " %}}Change{{% /badge %}} While switching the font, it was discovered that certain CSS variables were falsely named. You don't need to change anything in your custom variant stylesheet as the old names will be used as a fallback.
`--MAIN-TITLES-TEXT-font` was renamed to `--MAIN-TITLES-font`, `--MAIN-TITLES-H<n>-color` was renamed to `--MAIN-TITLES-H<n>-TEXT-color`.
## New
- {{% badge style="info" icon="plus-circle" title=" " %}}New{{% /badge %}} The docs received a much needed overhaul for all chapters besides [Shortcodes](shortcodes/).
Basically the structure was reorganized giving each topic its own page while keeping the amount of menu items comprehensible by adding sub pages.
The docs now clearly differentiate between [configuration of your site](configuration/) and all things [writing content](content/).
Also some previously undocumented features are now included, namely the [hidden pages](configuration/content/hidden/) feature, options of the [navigation menu](configuration/sidebar/navigationmenu/), configuring the [headings](configuration/content/headings/) of your content and adding [custom output formats](configuration/modifications/outputformats/).