PageConfig

This JSON file holds the high-level configuration of Git-Playbook and the document structure.

{

# configures the name of the app on the top-left corner

"appName": "Git", # configures the header (showing up on the top-right)

"headerNavigation": [

{

"name": "Playbook",

"path": "/playbook"

}

], # which of the pages on the playbook is the default landing

"landingPage": "/playbook", # configuration of the default page hierarchy

"pages": [

{

# the URL route we use to directly navigate to this page

"route": "/playbook",



# title of this page

"name": "Playbook", # description that shows up on the tile

"description": "This is the playbook",



# font awesome 5 icon from https://fontawesome.com/icons

"icon": "address-book", ": "This is the playbook",": "address-book", # array of topics this document should carry

"topics" : ["content", "main", "topic1"], # nested children that belong to this document

"children": [

{

# relative route to this nested doc, absolute route is

# /playbook/whatsNew

"route": "/whatsNew",

"name": "Whats new ?",

"description": "recent announcements, news, ...",

"icon": "bullhorn",

"topics" : ["topic1"], # reference to the actual content (markdown on static)

"markdown" : "/static/markdown/whatsnew/Current.md"

},

{

"route": "/links",

"name": "Helpful Links",

"description": "how to go from here ?",

"icon": "link",

"topics" : ["links", "topic2"],

"markdown" : "/static/markdown/Links.md"

},

{

"route": "/faq",

"name": "FAQs",

"description": "frequently asked questions are ...",

"icon": "question-circle",

"topics" : ["links", "topic2"],

"markdown" : "/static/markdown/FAQ.md"

},

{

"route": "/roadmap",

"name": "Our Roadmap",

"description": "aligning our development plans ...",

"icon": "map-marked-alt",

"markdown" : "/static/markdown/Roadmap.md"

},

{

"route": "/process",

"name": "Process Documentation",

"description": "anything about support process ...",

"icon": "project-diagram", # grand-children from the root node perspective

"children": [

{

"route": "/introduction",

"name": "Process Introduction",

"description": "how to read the process doc",

"icon": "project-diagram",

"markdown" : "/static/markdown/process/Intro.md"

},

{

"route": "/newPagesHowto",

"name": "New Pages HowTo",

"description": "how to create new Pages on ...",

"icon": "file-alt",

"markdown" : "/static/markdown/process/NewPages.md"

}

]

}

]

}

]

}

To add a new Page into the document hierarchy, simply duplicate one of the objects from pages and fill its appropriate values. If you want a ToC page, you need to use nested “children”. If you want a content page, you need to create the actual Content file (in Markdown) stored on the static folder and then reference its path on the “markdown” field. This procedure allows you to create whatever complexity you need for your product documentation on whatever levels of depth you want.

If you clone the “Git-Playbook” repository, this is the only file you need to touch.