mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-30 11:13:06 +00:00
24 lines
No EOL
7 KiB
XML
24 lines
No EOL
7 KiB
XML
<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Content on Documentation for Hugo Relearn Theme</title><link>https://McShelby.github.io/hugo-theme-relearn/cont/</link><description>Recent content in Content on Documentation for Hugo Relearn Theme</description><generator>Hugo -- gohugo.io</generator><language>en</language><atom:link href="https://McShelby.github.io/hugo-theme-relearn/cont/index.xml" rel="self" type="application/rss+xml"/><item><title>Pages organization</title><link>https://McShelby.github.io/hugo-theme-relearn/cont/pages/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/cont/pages/</guid><description>In Hugo, pages are the core of your site. Once it is configured, pages are definitely the added value to your documentation site.
|
|
Folders Organize your site like any other Hugo project. Typically, you will have a content folder with all your pages.
|
|
content ├── level-one │ ├── level-two │ │ ├── level-three │ │ │ ├── level-four │ │ │ │ ├── _index.md &lt;-- /level-one/level-two/level-three/level-four │ │ │ │ ├── page-4-a.</description></item><item><title>Multilingual and i18n</title><link>https://McShelby.github.io/hugo-theme-relearn/cont/i18n/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/cont/i18n/</guid><description>The Relearn theme is fully compatible with Hugo multilingual mode.
|
|
It provides:
|
|
Translation strings for default values (English, Arabic, Dutch, Piratized English, German, Hindi, Indonesian, Japanese, Piratized English, Portuguese, Russian, Simplified Chinese, Spanish, Turkish). Feel free to contribute! Automatic menu generation from multilingual content In-browser language switching Basic configuration After learning how Hugo handle multilingual websites, define your languages in your config.toml file.
|
|
For example with current English and Piratized English website.</description></item><item><title>Archetypes</title><link>https://McShelby.github.io/hugo-theme-relearn/cont/archetypes/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/cont/archetypes/</guid><description>Using the command: hugo new [relative new content path], you can start a content file with the date and title automatically set. While this is a welcome feature, active writers need more: archetypes.
|
|
It is pre-configured skeleton pages with default front matter. Please refer to the documentation for types of page to understand the differences.
|
|
Chapter To create a Chapter page, run the following commands
|
|
hugo new --kind chapter &lt;name&gt;/_index.md It will create a page with predefined Front-Matter:</description></item><item><title>Markdown syntax</title><link>https://McShelby.github.io/hugo-theme-relearn/cont/markdown/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/cont/markdown/</guid><description>Let&rsquo;s face it: Writing content for the Web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.
|
|
Markdown is a better way to write HTML, without all the complexities and ugliness that usually accompanies it.
|
|
Some of the key benefits are:
|
|
Markdown is simple to learn, with minimal extra characters so it&rsquo;s also quicker to write content. Less chance of errors when writing in Markdown.</description></item><item><title>Code highlighting</title><link>https://McShelby.github.io/hugo-theme-relearn/cont/syntaxhighlight/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/cont/syntaxhighlight/</guid><description>The Relearn theme uses Hugo&rsquo;s built-in syntax highlighting for code.
|
|
Markdown syntax Wrap the code block with three backticks and the name of the language. Highlight will try to auto detect the language if one is not provided.
|
|
```json [ { &#34;title&#34;: &#34;apples&#34;, &#34;count&#34;: [12000, 20000], &#34;description&#34;: {&#34;text&#34;: &#34;...&#34;, &#34;sensitive&#34;: false} }, { &#34;title&#34;: &#34;oranges&#34;, &#34;count&#34;: [17500, null], &#34;description&#34;: {&#34;text&#34;: &#34;...&#34;, &#34;sensitive&#34;: false} } ] ``` Renders to:
|
|
[ { &#34;title&#34;: &#34;apples&#34;, &#34;count&#34;: [12000, 20000], &#34;description&#34;: {&#34;text&#34;: &#34;.</description></item><item><title>Menu extra shortcuts</title><link>https://McShelby.github.io/hugo-theme-relearn/cont/menushortcuts/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/cont/menushortcuts/</guid><description>You can define additional menu entries or shortcuts in the navigation menu without any link to content.
|
|
Basic configuration Edit the website configuration config.toml and add a [[menu.shortcuts]] entry for each link your want to add.
|
|
Example from the current website:
|
|
[[menu.shortcuts]] name = &#34;&lt;i class=&#39;fab fa-fw fa-github&#39;&gt;&lt;/i&gt; GitHub repo&#34; identifier = &#34;ds&#34; url = &#34;https://github.com/McShelby/hugo-theme-relearn&#34; weight = 10 [[menu.shortcuts]] name = &#34;&lt;i class=&#39;fas fa-fw fa-camera&#39;&gt;&lt;/i&gt; Showcases&#34; url = &#34;/showcase/&#34; weight = 11 [[menu.</description></item><item><title>Icons and logos</title><link>https://McShelby.github.io/hugo-theme-relearn/cont/icons/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/cont/icons/</guid><description>The Relearn theme for Hugo loads the Font Awesome library, allowing you to easily display any icon or logo available in the Font Awesome free collection.
|
|
Finding an icon Browse through the available icons in the Font Awesome Gallery. Notice that the free filter is enabled, as only the free icons are available by default.
|
|
Once on the Font Awesome page for a specific icon, for example the page for the heart, copy the HTML reference and paste into the Markdown content.</description></item><item><title>Tags</title><link>https://McShelby.github.io/hugo-theme-relearn/cont/tags/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/cont/tags/</guid><description>The Relearn theme supports one default taxonomy of Hugo: the tag feature.
|
|
Configuration Just add tags to any page:
|
|
+++ tags = [&#34;tutorial&#34;, &#34;theme&#34;] title = &#34;Theme tutorial&#34; weight = 15 +++ Behavior The tags are displayed at the top of the page, in their insertion order.
|
|
Each tag is a link to a Taxonomy page displaying all the articles with the given tag.
|
|
List all the tags In the config.</description></item></channel></rss> |