Skip to content

Page Setup & Information

VerzatileDev edited this page May 21, 2024 · 11 revisions

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: Example
has_children: false
---

Available:


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:

 ![image](https://github.com/VerzatileDevOrg/Programming_HandBook/assets/47317248/60250b1b-1c0e-4d79-a2ca-f04b4c85c2a9)

 ![image](https://github.com/VerzatileDevOrg/Programming_HandBook/assets/47317248/e03259e2-bc9a-4a88-b648-4591c20b72af)
 
 ![image](https://github.com/VerzatileDevOrg/Programming_HandBook/assets/47317248/669d50fc-333b-4cc2-8a62-c7f7e0517186)


 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

parent: (Name of the .md file

 * An example `VersionControl.md` would reference it as `Version Control`, this lists the content into the navigation panel.

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:


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

Clone this wiki locally