Skip to content
This repository has been archived by the owner on Sep 14, 2023. It is now read-only.

nesi/flexi-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This repo has been moved to https://github.com/nesi/research-developer-cloud, this is now archived and will be deleted in the future

NeSI FlexiHPC User Guide Documentation

This is the content that hosts the site https://nesi.github.io/flexi-docs/

File layout

docs/

Location of markdown docs. File structure determines categories and sections. A section or category can be replaced by an index.md file, this will replace the default nav with a page.

docs/assets

This is broken down into a few things, treat this as site assets like css, images or files(pdfs etc)

docs/base_folder_name

This is normally the base folder structure that houses the markdown documents for that subject, example would be docs/user-guides houses all the user guides for flexi

summary and index

These 2 files are used as the following

index.md is the base page for that section or group

summary.md is the nav structure for that section or group, if not supplied then the site will tile all markdown docs out

Theme

https://squidfunk.github.io/mkdocs-material/

Contributing

We welcome contributions to our FlexiHPC User guides. Please read CONTRIBUTING.md