Mattescantcode / scenicroute.github.io

Maintenance of wiki Pages.

Customization

• Anything under Dev Should go in the WIP folder - this is hidden by default and wont get turned into a page.
• There should be a blank line between a title (#title) and the contents. Likewise between a paragraph and a --- (line break) else Jekell wont format it properly.
• Jekell can handle a Mix of markdown and HTML - But if you want to include a collapaseable section containing markdown - you need to wrap the MD in a
  MD goes here
  Block to format the MD properly.
• Youtube videos can be embedded - but you need the embed block from yourtube itself - you cant just stick it in a Iframe.
• Unlike regular markdown - you can use HTML to change colors in the page.
• Dont touch the config.yaml or CSS pages - Dylan has final say over the color scheme.

Each page should have a header block

---                            Required
layout: default                Required - Leave this alone
title: Keybindings             Required - Title of the page (appears on nav bar)
has_toc: true                  Optional - If the page has children - Does it include a Table of contents for its children
has_children: true             Optional - If this page is going to have children underneath it.    Optional - If the page is a child - Its parent should go here
  Optional - If the parent is a child - the parents parent title does here
nav_order: 8                   Optional - Position in the Nav bar under its parent (e.g 1 is the first page under the parent) 
description: Keybinds          Optional - a description for the page which will appear if the page is linked.
---                            Required

For callouts

{: .warning}
> Call out text goes here.
>
> Each line should have a blank line between it.

• Red - Super important things that users need to know
• Yellow - Warnings / Important info that users should know.
• Green - Notes & hints that users might want to know.

Code blocks should only be used for crafting recipes & formala's - not as a highlight.

code blocks are surrounded by 3 apostrphies, or by being tab indented

To include a table of contents

  ## Table of contents
  {: .no_toc }
<details open markdown="block">
  <summary>
    Table of contents
    Table of contents
  {: .text-delta }
1. TOC
{:toc}
</details>

to include a 'Button' Link

[description](link){: .btn .btn-pink }

---

Other links

• Jekyll https://jekyllrb.com
• Just the Docs https://just-the-docs.github.io/just-the-docs/
• jekyll-default-layout https://github.com/benbalter/jekyll-default-layout