mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.This part is for collaborators and developers.
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.
To work locally with this project, you'll have to follow the steps below:
- Fork, clone or download this project
- Create and activate conda env
cd sandboxbio-IFB-docs
conda env create -f env_docs.yml
conda activate docs- Preview your project
mkdocs serveNote : The site can be accessed under http://localhost:8000/
- Add content
Add/update markdown files in docs folder
- Test
mkdocs build- Deploy
Only if previous command is Ok !
mkdocs gh-deploy --forceIf 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.ymlRead more at:
- MkDocs documentation
- Mkdocs Material documentation
If you use our guide, please cite us :
IFB-ElixirFr, Sandbox.bio hosted by IFB documentation, https://github.com/IFB-ElixirFr/sandboxbio-IFB-docs
A DOI with Zenodo is comming.
Please, see the CONTRIBUTING file.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See CODE_OF_CONDUCT file.
Our guide is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.
- All contributors
- Official documentation : https://www.mkdocs.org/
- Material (best extension !) : https://squidfunk.github.io/mkdocs-material/
- Multi language structure : squidfunk/mkdocs-material#2346