lkhamvongsa / openondemanddoc

Open ondemand documentation for IFB cluster

Project layout

    mkdocs.yml    # The configuration file.
    docs/
        index.md  # The documentation homepage.
        ...       # Other markdown pages, images and other files.

For collaborators and developers

This part is for collaborators and developers.

Modify content

When you are in the repository, add and/or modify your markdown tutorials in the docs directory. The arborescence of the website menu is to setup in the mkdocs.yml file.

Mkdocs

To work locally with this project, you'll have to follow the steps below:

1. Fork, clone or download this project
2. Create and activate conda env

cd OnpenOnDemandDoc
conda env create -f env_docs.yml
conda activate docs

3. Preview your project

mkdocs serve

Note : The site can be accessed under http://localhost:8000/

4. Add content

Add/update markdown files in docs folder

5. Test

mkdocs build

6. Deploy

Only if previous command is Ok !

mkdocs gh-deploy --force

If you add an extension to (Material) MKdocs that requires the installation of a new package. Don't forget to export the conda environment (env_docs.yml) using the command line below.

conda env export --no-builds env_docs.yml

Read more at:

• MkDocs documentation
• Mkdocs Material documentation

Citation

...

Contributors

• Lucie Khamvongsa

License

Our guide is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

Acknowledgement

• All contributors

Ressources

mkdocs

• Official documentation : https://www.mkdocs.org/
• Material (best extension !) : https://squidfunk.github.io/mkdocs-material/
• Multi language structure : squidfunk/mkdocs-material#2346