Page Setup & Information

Setup

Each new page requires the use of the base paneling on top of the page from line (1).

Basic example:

---
layout: default
title: Title
nav_order: 1
parent: Example2
---

layout: (default,..)

As a principle each page requires the use of the default layout, unless its puropse is to modify the core aspect of the entire page upon then it requires a re-write to the core and modifications for the intended purpose.

title: (Add your own title)

This modifies the Page title within the browser
Linked with the use of {{ page.title }}, which shows the title: .. on the page before content.

Example:

Note:
- The use of {{ page.title }} is not required if the page title is different to the tile of the browser shown.
- Though use ====================== after the tile for seperation and page functionality.

nav_order: (Can be 1 to 100)

Changes the order within the folder that the current file sits in and showns to the main website navigation bar.
The following should be at 1 if the purpose is to order them on the base of an alphabetical ordering.
- If any other it will be ordered on the basis of the number such as 5 would position itself on the 5th spot within the navigation bar on the left.

has_children: (False or True)

Enable the following if the following content has a child and the grand_parent and parent is enabled to the ones before the current one it sits in.
Folder, folder.md, SecondFolder, secondfolder.md

Not required from v1.0.2

parent: (Name of the `.md` file

An example VersionControl.md would reference it as Version Control, this lists the content into the navigation panel.
In an instance where the file sits within the Root Folder structure such as "Doc" folder and its the first entry to it even if it is within a folder such as (Root -> MyFolder / MyFolder.md) The given .md first for the root does not require the use of Parent.

As for example:

https://github.com/VerzatileDevOrg/Programming_HandBook/blob/main/docs/Concepts/Concepts.md?plain=1

grand_parent: (Base folder/NewFolder/CurrentFile)

An example ConstantPointerToConstant.md is located within c++ folder that itself is part of the Language folder.
This makes Language to be the grandparent to the current child.
This makes c++ to be the parent of the current child.

Note:

Please use these carefully and test them locally!
Grand Grand Parent (Currently not available). Referenced in issue https://github.com/VerzatileDevOrg/Programming_HandBook/issues/61

Not required from v1.0.2

search_exclude: (True / False)

The following stops the pages content showing up in the search bar if enabled as true by default its false.

nav_exclude: (True / False)

The following stops the section showing up within the navigation bar on the left side of the page.

Publishing:

When publishing a new resource and writing the page yourself please remember to use the following statement at the bottom of the page:

---

#### Author: Your Name
#### Published: Date Published DD/MM/YY

First Page Example within the List:

Layout -> Does not require changing and should remain as (default)

Title -> This is important, that no other Title is the same as the current one as the title will be used to reference Itself on the next page as it becomes a parent as such (parent: Title ) for the page that is after it as for example (title: New Title)

nav_order: (1 - 100) This is used for arrangement within the current list such as a folder named (example) and all the elements placed in it can be ordered based on it, 1 being 1st and 100 the last. If not defined it will be ordered and based by Alphabetical ordering!

Parent -> Only required for any page after first if it has children. And requires the previous pages Name such as the (title: ... )

For the following has_children (true / false), false will not show the next child in the list and true it will show it.

---
layout: default
title: Title
nav_order: 1
has_children: true
---


{{ page.title }}
======================


## Start of the Topic

### Inner Topic

#### Inner Topic's examples (And Such)


{: .warning}
Write content on the same line and seperate with a <br>
Now it can be written here though not the next line over it.

{: .note}
Write your Note content here.

{: .example}
An example content here.

---

#### Author: Your Name
#### Published: Date Published DD/MM/YY

Second Page Example within the List:

Layout -> default

Title -> Title2

nav_order: 1

Parent -> Title

---
layout: default
title: Title2
nav_order: 1
parent: Title
---


{{ page.title }}
======================


## Start of the Topic

### Inner Topic

#### Inner Topic's examples (And Such)


{: .warning}
Write content on the same line and seperate with a <br>
Now it can be written here though not the next line over it.

{: .note}
Write your Note content here.

{: .example}
An example content here.

---

#### Author: Your Name
#### Published: Date Published DD/MM/YY

Content Written By VerzatileDev, 2024