README.md

Wasm4Learn documentation

Overview

Language

Continuous Integration

Questions

💬 Ask a question 📖 Report a problem or an idea

Contribution

Project layout

    mkdocs.yml         # The configuration file.
    docs/
        Deployement/   # deployement steps for each repository
            ...
        Components/    # Component usable in the (md) files
            ...
        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 Wasm4Learn-doc
conda env create -f env_docs.yml
conda activate docs_was4learn

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

7. 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

Reminder : Don't forget to commit and push your changed md files in the main branch

Read more at:

• MkDocs documentation
• Mkdocs Material documentation

Citation

If you use our guide, please cite us :

IFB-ElixirFr, Wasm4learn documentation, https://github.com/IFB-ElixirFr/Wasm4Learn-doc

A DOI with Zenodo is comming.

Contributors

• Thomas Denecker
• Imane Messak

Contributing

Please, see the CONTRIBUTING file.

Contributor Code of Conduct

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.

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