mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-27 17:53:07 +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>Rambl'n on Documentat'n fer Cap'n Hugo Relearrrn Theme</title><link>https://McShelby.github.io/hugo-theme-relearn/pir/cont/</link><description>Recent content in Rambl'n on Documentat'n fer Cap'n Hugo Relearrrn Theme</description><generator>Hugo -- gohugo.io</generator><language>en</language><atom:link href="https://McShelby.github.io/hugo-theme-relearn/pir/cont/index.xml" rel="self" type="application/rss+xml"/><item><title>Planks orrrganizat'n</title><link>https://McShelby.github.io/hugo-theme-relearn/pir/cont/pages/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/pir/cont/pages/</guid><description>In Cap'n Hugo, planks be th' core o' yer ship. Once it be configured, planks be definitely th' added value t' yer documentat'n ship.
|
|
Folders Org'nize yer ship like any other Cap'n Hugo project. Typically, ye will have a rambl'n folder wit' all yer planks.
|
|
rambl'n ├── 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 an' i18n</title><link>https://McShelby.github.io/hugo-theme-relearn/pir/cont/i18n/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/pir/cont/i18n/</guid><description>Th' Relearrrn theme be fully compat'ble wit' Cap'n Hugo multilingual mode.
|
|
It provides:
|
|
Translat'n str'ns fer default values (English, Arabic, Dutch, Piratized English, German, Hindi, Indonesian, Japanese, Piratized English, Portuguese, Russian, Simplified Chinese, Spanish, Turkish). Feel free t' contribute! Automatic menu generat'n from multilingual rambl'n In-browser language switch'n Basic configurat'n Aft learn'n how Cap'n Hugo handle multilingual websites, define yer languages 'n yer config.toml file.
|
|
For example wit' current English an' Piratized English website.</description></item><item><title>Arrrchetypes</title><link>https://McShelby.github.io/hugo-theme-relearn/pir/cont/archetypes/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/pir/cont/archetypes/</guid><description>Us'n th' command: hugo new [relative new rambl'n path], ye can start a rambl'n file wit' th' date an' title automatically set. While this be a welcome feature, active writers need more: archetypes.
|
|
It be pre-configured skeleton planks wit' default front matter. Please refer t' th' documentat'n fer types o' plank t' understand th' differences.
|
|
Chapter T' create a Chapter plank, run th' follow'n commands
|
|
hugo new --kind chapter &lt;name&gt;/_index.</description></item><item><title>Marrrkdown rules</title><link>https://McShelby.github.io/hugo-theme-relearn/pir/cont/markdown/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/pir/cont/markdown/</guid><description>Let&rsquo;s face it: Writ'n rambl'n fer th' Web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks.
|
|
Marrrkdown be a better way t' write HTML, without all th' complexities an' ugliness that usually accompanies it.
|
|
Some o' th' key benefits be:
|
|
Marrrkdown be simple t' learn, wit' minimal extra characters so it&rsquo;s also quicker t' write rambl'n.</description></item><item><title>Code highlight'n</title><link>https://McShelby.github.io/hugo-theme-relearn/pir/cont/syntaxhighlight/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/pir/cont/syntaxhighlight/</guid><description>Th' Relearrrn theme uses Hugo&rsquo;s built-in rules highlight'n fer code.
|
|
Marrrkdown rules Wrap th' code block wit' three backticks an' th' name o' th' language. Highlight will try t' auto detect th' language if one be 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 t':
|
|
[ { &#34;title&#34;: &#34;apples&#34;, &#34;count&#34;: [12000, 20000], &#34;description&#34;: {&#34;text&#34;: &#34;.</description></item><item><title>Menu extrrra shorrrtcuts</title><link>https://McShelby.github.io/hugo-theme-relearn/pir/cont/menushortcuts/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/pir/cont/menushortcuts/</guid><description>Ye can define additional menu entries or shortcuts 'n th' navigat'n menu without any link t' rambl'n.
|
|
Basic configurat'n Edit th' website configurat'n config.toml an' add a [[menu.shortcuts]] entry fer each link yer want t' add.
|
|
Example from th' 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>Ay'cons an' logos</title><link>https://McShelby.github.io/hugo-theme-relearn/pir/cont/icons/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/pir/cont/icons/</guid><description>Th' Relearrrn theme fer Cap'n Hugo loads th' Font Awesome library, allow'n ye t' easily display any ay'con or logo avail'ble 'n th' Font Awesome free collect'n.
|
|
Find'n an ay'con Browse through th' avail'ble ay'cons 'n th' Font Awesome Gallery. Notice that th' free filter be enabled, as only th' free ay'cons be avail'ble by default.
|
|
Once on th' Font Awesome plank fer a specific ay'con, fer example th' plank fer th' heart, copy th' HTML reference an' paste into th' Marrrkdown rambl'n.</description></item><item><title>Tags</title><link>https://McShelby.github.io/hugo-theme-relearn/pir/cont/tags/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://McShelby.github.io/hugo-theme-relearn/pir/cont/tags/</guid><description>Th' Relearrrn theme supports one default taxonomy o' Cap'n Hugo: th' tag feature.
|
|
Configurat'n Just add tags t' any plank:
|
|
+++ tags = [&#34;tutorial&#34;, &#34;theme&#34;] title = &#34;Theme tutorial&#34; weight = 15 +++ Behavior Th' tags be displayed at th' top o' th' plank, 'n their insert'n order.
|
|
Each tag be a link t' a Taxonomy plank display'n all th' articles wit' th' given tag.
|
|
List all th' tags In th' config.</description></item></channel></rss> |