mirror of
				https://github.com/McShelby/hugo-theme-relearn.git
				synced 2025-11-04 02:04:49 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			155 lines
		
	
	
	
		
			13 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			155 lines
		
	
	
	
		
			13 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
<!DOCTYPE html>
 | 
						||
<html lang="art-pir" dir="rtl">
 | 
						||
  <head>
 | 
						||
    <meta charset="utf-8">
 | 
						||
    <meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0">
 | 
						||
    <meta name="generator" content="Hugo 0.124.1">
 | 
						||
    <meta name="generator" content="Relearn 5.27.0+tip">
 | 
						||
    <meta name="description" content="Documentation for Hugo Relearn Theme">
 | 
						||
    <meta name="author" content="Sören Weber">
 | 
						||
    <meta name="twitter:card" content="summary_large_image">
 | 
						||
    <meta name="twitter:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
 | 
						||
    <meta name="twitter:title" content="planks orrrganizat'n :: Cap'n Hugo Relearrrn Theme">
 | 
						||
    <meta name="twitter:description" content="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 rrrambl'n folder wit' all yer planks.
 | 
						||
rrrambl'n ├── level-one │ ├── level-two │ │ ├── level-three │ │ │ ├── level-four │ │ │ │ ├── _index.md <-- /level-one/level-two/level-three/level-four │ │ │ │ ├── page-4-a.">
 | 
						||
    <meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/pir/cont/pages/index.html">
 | 
						||
    <meta property="og:site_name" content="Cap'n Hugo Relearrrn Theme">
 | 
						||
    <meta property="og:title" content="planks orrrganizat'n :: Cap'n Hugo Relearrrn Theme">
 | 
						||
    <meta property="og:description" content="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 rrrambl'n folder wit' all yer planks.
 | 
						||
rrrambl'n ├── level-one │ ├── level-two │ │ ├── level-three │ │ │ ├── level-four │ │ │ │ ├── _index.md &lt;-- /level-one/level-two/level-three/level-four │ │ │ │ ├── page-4-a.">
 | 
						||
    <meta property="og:locale" content="art-pir">
 | 
						||
    <meta property="og:type" content="article">
 | 
						||
    <meta property="article:section" content="Rambl'n :: Cap'n Hugo Relearrrn Theme">
 | 
						||
    <meta property="og:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
 | 
						||
    <title>planks orrrganizat'n :: Cap'n Hugo Relearrrn Theme</title>
 | 
						||
    <link href="https://mcshelby.github.io/hugo-theme-relearn/cont/pages/index.html" rel="alternate" hreflang="x-default">
 | 
						||
    <link href="https://mcshelby.github.io/hugo-theme-relearn/cont/pages/index.html" rel="alternate" hreflang="en">
 | 
						||
    <link href="https://mcshelby.github.io/hugo-theme-relearn/pir/cont/pages/index.html" rel="alternate" hreflang="art-pir">
 | 
						||
    <link href="https://mcshelby.github.io/hugo-theme-relearn/pir/cont/pages/index.html" rel="canonical" type="text/html" title="planks orrrganizat'n :: Cap'n Hugo Relearrrn Theme">
 | 
						||
    <link href="/hugo-theme-relearn/pir/cont/pages/index.xml" rel="alternate" type="application/rss+xml" title="planks orrrganizat'n :: Cap'n Hugo Relearrrn Theme">
 | 
						||
    <link href="/hugo-theme-relearn/images/logo.svg?1712528109" rel="icon" type="image/svg+xml">
 | 
						||
    <!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
 | 
						||
    <link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1712528111" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1712528111" rel="stylesheet"></noscript>
 | 
						||
    <link href="/hugo-theme-relearn/css/nucleus.css?1712528111" rel="stylesheet">
 | 
						||
    <link href="/hugo-theme-relearn/css/auto-complete.css?1712528111" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1712528111" rel="stylesheet"></noscript>
 | 
						||
    <link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1712528111" rel="stylesheet">
 | 
						||
    <link href="/hugo-theme-relearn/css/fonts.css?1712528111" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1712528111" rel="stylesheet"></noscript>
 | 
						||
    <link href="/hugo-theme-relearn/css/theme.css?1712528111" rel="stylesheet">
 | 
						||
    <link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1712528111" rel="stylesheet" id="R-variant-style">
 | 
						||
    <link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1712528111" rel="stylesheet" id="R-variant-chroma-style">
 | 
						||
    <link href="/hugo-theme-relearn/css/variant.css?1712528111" rel="stylesheet">
 | 
						||
    <link href="/hugo-theme-relearn/css/print.css?1712528111" rel="stylesheet" media="print">
 | 
						||
    <link href="/hugo-theme-relearn/css/format-print.css?1712528111" rel="stylesheet">
 | 
						||
    <link href="/hugo-theme-relearn/css/ie.css?1712528111" rel="stylesheet">
 | 
						||
    <script src="/hugo-theme-relearn/js/url.js?1712528111"></script>
 | 
						||
    <script src="/hugo-theme-relearn/js/variant.js?1712528111"></script>
 | 
						||
    <script>
 | 
						||
      window.relearn = window.relearn || {};
 | 
						||
      window.relearn.relBasePath='..\/..\/..';
 | 
						||
      window.relearn.relBaseUri='..\/..\/..\/..';
 | 
						||
      window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn';
 | 
						||
      window.index_js_url="/hugo-theme-relearn/pir/index.search.js";
 | 
						||
      // variant stuff
 | 
						||
      window.relearn.themeVariantModifier='';
 | 
						||
      window.variants && variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'neon', 'learn', 'blue', 'green', 'red' ] );
 | 
						||
      // translations
 | 
						||
      window.T_Copy_to_clipboard = `Copy t' clipboard`;
 | 
						||
      window.T_Copied_to_clipboard = `Copied t' clipboard!`;
 | 
						||
      window.T_Copy_link_to_clipboard = `Copy link t' clipboard`;
 | 
						||
      window.T_Link_copied_to_clipboard = `Copied link t' clipboard!`;
 | 
						||
      window.T_Reset_view = `Rrreset view`;
 | 
						||
      window.T_View_reset = `View rrreset!`;
 | 
						||
      window.T_No_results_found = `No rrresults found fer "{0}"`;
 | 
						||
      window.T_N_results_found = `{1} rrresults found fer "{0}"`;
 | 
						||
    </script>
 | 
						||
    <style>
 | 
						||
      #R-body img.bg-white {
 | 
						||
        background-color: white;
 | 
						||
      }
 | 
						||
    </style>
 | 
						||
  </head>
 | 
						||
  <body class="mobile-support print disableInlineCopyToClipboard" data-url="/hugo-theme-relearn/pir/cont/pages/index.html">
 | 
						||
    <div id="R-body" class="default-animation">
 | 
						||
      <div id="R-body-overlay"></div>
 | 
						||
      <nav id="R-topbar">
 | 
						||
        <div class="topbar-wrapper">
 | 
						||
          <div class="topbar-sidebar-divider"></div>
 | 
						||
          <div class="topbar-area topbar-area-start" data-area="start">
 | 
						||
            <div class="topbar-button topbar-button-sidebar" data-content-empty="disable" data-width-s="show" data-width-m="hide" data-width-l="hide"><button class="topbar-control" onclick="toggleNav()" type="button" title="Menu (CTRL+ALT+n)"><i class="fa-fw fas fa-bars"></i></button>
 | 
						||
            </div>
 | 
						||
          </div>
 | 
						||
          <ol class="topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype="http://schema.org/BreadcrumbList"><li
 | 
						||
            itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="/hugo-theme-relearn/pir/cont/index.html"><span itemprop="name">Rambl'n</span></a><meta itemprop="position" content="1"> > </li><li
 | 
						||
            itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">planks orrrganizat'n</span><meta itemprop="position" content="2"></li>
 | 
						||
          </ol>
 | 
						||
          <div class="topbar-area topbar-area-end" data-area="end">
 | 
						||
            <div class="topbar-button topbar-button-prev" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/pir/cont/index.html" title="Rambl'n (🡒)"><i class="fa-fw fas fa-chevron-left"></i></a>
 | 
						||
            </div>
 | 
						||
            <div class="topbar-button topbar-button-next" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/pir/cont/frontmatter/index.html" title="Frrrontmatter (🡐)"><i class="fa-fw fas fa-chevron-right"></i></a>
 | 
						||
            </div>
 | 
						||
          </div>
 | 
						||
        </div>
 | 
						||
      </nav>
 | 
						||
      <div id="R-main-overlay"></div>
 | 
						||
      <main id="R-body-inner" class="highlightable default" tabindex="-1">
 | 
						||
        <div class="flex-block-wrapper">
 | 
						||
          <article class="default">
 | 
						||
            <header class="headline">
 | 
						||
            </header>
 | 
						||
 | 
						||
<h1 id="planks-orrrganizatn">planks orrrganizat'n</h1>
 | 
						||
 | 
						||
 | 
						||
<p>In <strong>Cap'n Hugo</strong>, planks be th' core o' yer ship. Once it be configured, planks be definitely th' added value t' yer documentat'n ship.</p>
 | 
						||
<h2 id="folders">Folders</h2>
 | 
						||
<p>Org'nize yer ship like <a href="https://gohugo.io/content/organization/" rel="external" target="_blank">any other Cap'n Hugo project</a>. Typically, ye will have a <em>rrrambl'n</em> folder wit' all yer planks.</p>
 | 
						||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line"><span class="cl">rrrambl'n
 | 
						||
</span></span><span class="line"><span class="cl">├── level-one
 | 
						||
</span></span><span class="line"><span class="cl">│   ├── level-two
 | 
						||
</span></span><span class="line"><span class="cl">│   │   ├── level-three
 | 
						||
</span></span><span class="line"><span class="cl">│   │   │   ├── level-four
 | 
						||
</span></span><span class="line"><span class="cl">│   │   │   │   ├── _index.md       <-- /level-one/level-two/level-three/level-four
 | 
						||
</span></span><span class="line"><span class="cl">│   │   │   │   ├── page-4-a.md     <-- /level-one/level-two/level-three/level-four/page-4-a
 | 
						||
</span></span><span class="line"><span class="cl">│   │   │   │   ├── page-4-b.md     <-- /level-one/level-two/level-three/level-four/page-4-b
 | 
						||
</span></span><span class="line"><span class="cl">│   │   │   │   └── page-4-c.md     <-- /level-one/level-two/level-three/level-four/page-4-c
 | 
						||
</span></span><span class="line"><span class="cl">│   │   │   ├── _index.md           <-- /level-one/level-two/level-three
 | 
						||
</span></span><span class="line"><span class="cl">│   │   │   ├── page-3-a.md         <-- /level-one/level-two/level-three/page-3-a
 | 
						||
</span></span><span class="line"><span class="cl">│   │   │   ├── page-3-b.md         <-- /level-one/level-two/level-three/page-3-b
 | 
						||
</span></span><span class="line"><span class="cl">│   │   │   └── page-3-c.md         <-- /level-one/level-two/level-three/page-3-c
 | 
						||
</span></span><span class="line"><span class="cl">│   │   ├── _index.md               <-- /level-one/level-two
 | 
						||
</span></span><span class="line"><span class="cl">│   │   ├── page-2-a.md             <-- /level-one/level-two/page-2-a
 | 
						||
</span></span><span class="line"><span class="cl">│   │   ├── page-2-b.md             <-- /level-one/level-two/page-2-b
 | 
						||
</span></span><span class="line"><span class="cl">│   │   └── page-2-c.md             <-- /level-one/level-two/page-2-c
 | 
						||
</span></span><span class="line"><span class="cl">│   ├── _index.md                   <-- /level-one
 | 
						||
</span></span><span class="line"><span class="cl">│   ├── page-1-a.md                 <-- /level-one/page-1-a
 | 
						||
</span></span><span class="line"><span class="cl">│   ├── page-1-b.md                 <-- /level-one/page-1-b
 | 
						||
</span></span><span class="line"><span class="cl">│   └── page-1-c.md                 <-- /level-one/page-1-c
 | 
						||
</span></span><span class="line"><span class="cl">├── _index.md                       <-- /
 | 
						||
</span></span><span class="line"><span class="cl">└── page-top.md                     <-- /page-top</span></span></code></pre></div>
 | 
						||
<div class="box notices cstyle note">
 | 
						||
  <div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Avast</div>
 | 
						||
  <div class="box-content">
 | 
						||
 | 
						||
<p><code>_index.md</code> be required 'n each folder, it’s yer “folder home page”</p>
 | 
						||
</div>
 | 
						||
</div>
 | 
						||
<h2 id="create-your-project">Create yer project</h2>
 | 
						||
<p>Th' follow'n steps be here t' help ye initialize yer new website. If ye don’t know Cap'n Hugo at all, we strongly suggest ye t' train by follow'n <a href="https://gohugo.io/overview/quickstart/" rel="external" target="_blank">great documentat'n fer beginners</a>.</p>
 | 
						||
<p>Cap'n Hugo provides a <code>new</code> command t' create a new website.</p>
 | 
						||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">hugo new ship <new_project></span></span></code></pre></div><p>Th' Relearrrn theme provides <a href="/hugo-theme-relearn/pir/cont/archetypes/index.html">archetypes</a> t' help ye create this kind o' planks.</p>
 | 
						||
 | 
						||
 | 
						||
            <footer class="footline">
 | 
						||
            </footer>
 | 
						||
          </article>
 | 
						||
 | 
						||
        </div>
 | 
						||
      </main>
 | 
						||
    </div>
 | 
						||
    <script src="/hugo-theme-relearn/js/clipboard.min.js?1712528111" defer></script>
 | 
						||
    <script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1712528111" defer></script>
 | 
						||
    <script src="/hugo-theme-relearn/js/theme.js?1712528111" defer></script>
 | 
						||
  </body>
 | 
						||
</html>
 |