Merge pull request #2 from shellbox-sh/userGuide

User Guide

Author: beccasaurus

README.md

@@ -33,6 +33,8 @@ sidebar:
     url: "#pen-cleanslate"
   - title: '<code>$pen putAway</code>'
     url: "#pen-putaway"
+  - title: '<code>shellpen extend</code>'
+    url: "#shellpen-extend"
 
 - title: "Writing Basics"
   url: "#writing-basics"
@@ -43,8 +45,8 @@ sidebar:
     url: "#-command"
   - title: '<code>shebang</code>'
     url: "#shebang"
-  - title: '<code>fn</code>'
-    url: "#fn"
+  - title: '<code>function</code>'
+    url: "#function"
   - title: '<code>main</code>'
     url: "#main"
 
@@ -108,18 +110,8 @@ sidebar:
     url: "#fromfile"
   - title: '<code>fromCommand</code>'
     url: "#fromcommand"
-
-- title: "Extending the Syntax"
-  url: "#extending-the-syntax"
-  children:
-  - title: '<code>shellpen extend</code>'
-    url: "#shellpen-extend"
-  - title: '<code>return 0</code> or <code>return 1</code>'
-    url: "#return-0-or-return-1m"
-  - title: '<code>return 2</code>'
-    url: "#return-2"
-  - title: '<code>\|</code> <code>AND</code> <code>OR</code>'
-    url: "#-and-or"
+  - title: '<code>fromText</code>'
+    url: "#fromtext"
 
 command_reference:
 - title: "🔙 to ShellPen"
@@ -274,31 +266,19 @@ extensions_reference:
 - title: "🔙 to ShellPen"
   url: "/"
   children:
-  - title: "🖋️ Extending Syntax"
-    url: "/extensions"
   - title: 'Create an extension'
-    url: '#link'
-  - title: 'Write custom syntax'
-    url: '#link'
+    url: '/extensions/#create-an-extension'
   - title: 'Indentation with blocks'
-    url: '#link'
-  - title: 'Cleanup on block close'
-    url: '#link'
-  - title: 'Supporting empty blocks'
-    url: '#link'
+    url: '/extensions/#indentation-with-blocks'
 - title: "🖋️ Examples"
-  url: "/extensions"
+  url: "/extensions/hello"
   children:
   - title: 'Hello, Extension!'
-    url: '#link'
-  - title: 'Printing Pretty Errors'
-    url: '#link'
-  - title: 'Branch on BASH version'
-    url: '#link'
+    url: '/extensions/hello'
 - title: "🖋️ API Reference"
   url: "/extensions"
   children:
-  - title: '<code>extend</code>'
+  - title: '<code>shellpen extend</code>'
     url: '/extensions/extend'
   - title: '<code>$PEN</code>'
     url: '/extensions/PEN'

docs/_data/navigation.yml

@@ -24,11 +24,12 @@
     {% if page.last_modified_at %}<meta itemprop="dateModified" content="{{ page.last_modified_at | date_to_xmlschema }}">{% endif %}
 
     <div class="page__inner-wrap">
-      {% unless page.header.overlay_color or page.header.overlay_image %}
+      <!-- {% unless page.header.overlay_color or page.header.overlay_image %}
         <header>
+          {% if page.title %}<h1 id="page-title" class="page__title" itemprop="headline">{{ page.title | markdownify | remove: "<p>" | remove: "</p>" }}</h1>{% endif %}
           {% include page__meta.html %}
         </header>
-      {% endunless %}
+      {% endunless %} -->
 
       <section class="page__content" itemprop="text">
         {% if page.toc %}

docs/_layouts/singleModified.html renamed to docs/_layouts/singleWithoutTitle.html

@@ -1,11 +1,13 @@
 ---
-title: '🖋️ Command Reference'
+title: '$ • 🖋️ Command Reference'
 permalink: /docs/$
-layout: single
+layout: 'singleWithoutTitle'
 sidebar:
   nav: 'command_reference'
 ---
 
+# 🖋️ Command Reference
+
 ---
 
 # `$`

docs/_pages/commands/$.md

@@ -1,11 +1,13 @@
 ---
-title: '🖋️ Command Reference'
+title: ', • 🖋️ Command Reference'
 permalink: /docs/,
-layout: single
+layout: 'singleWithoutTitle'
 sidebar:
   nav: 'command_reference'
 ---
 
+# 🖋️ Command Reference
+
 ---
 
 # `,`

docs/_pages/commands/,.md

@@ -1,11 +1,13 @@
 ---
-title: '🖋️ Extending Syntax'
+title: '--eval-full-stack • 🖋️ Extending Syntax'
 permalink: /extensions/--eval-full-stack
-layout: single
+layout: 'singleWithoutTitle'
 sidebar:
   nav: 'extensions_reference'
 ---
 
+# 🖋️ Extending Syntax
+
 ---
 
 # `--eval-full-stack`

docs/_pages/commands/--eval-full-stack.md

@@ -1,11 +1,13 @@
 ---
-title: '🖋️ Extending Syntax'
+title: '--eval-last-pushed • 🖋️ Extending Syntax'
 permalink: /extensions/--eval-last-pushed
-layout: single
+layout: 'singleWithoutTitle'
 sidebar:
   nav: 'extensions_reference'
 ---
 
+# 🖋️ Extending Syntax
+
 ---
 
 # `--eval-last-pushed`

docs/_pages/commands/--eval-last-pushed.md

@@ -1,11 +1,13 @@
 ---
-title: '🖋️ Extending Syntax'
+title: '--get-last-pushed • 🖋️ Extending Syntax'
 permalink: /extensions/--get-last-pushed
-layout: single
+layout: 'singleWithoutTitle'
 sidebar:
   nav: 'extensions_reference'
 ---
 
+# 🖋️ Extending Syntax
+
 ---
 
 # `--get-last-pushed`

docs/_pages/commands/--get-last-pushed.md

@@ -1,11 +1,13 @@
 ---
-title: '🖋️ Extending Syntax'
+title: '--get-stack • 🖋️ Extending Syntax'
 permalink: /extensions/--get-stack
-layout: single
+layout: 'singleWithoutTitle'
 sidebar:
   nav: 'extensions_reference'
 ---
 
+# 🖋️ Extending Syntax
+
 ---
 
 # `--get-stack`

docs/_pages/commands/--get-stack.md

@@ -1,11 +1,13 @@
 ---
-title: '🖋️ Extending Syntax'
+title: '--mark-last-not-empty • 🖋️ Extending Syntax'
 permalink: /extensions/--mark-last-not-empty
-layout: single
+layout: 'singleWithoutTitle'
 sidebar:
   nav: 'extensions_reference'
 ---
 
+# 🖋️ Extending Syntax
+
 ---
 
 # `--mark-last-not-empty`