Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 1.25 KB

README.md

File metadata and controls

24 lines (17 loc) · 1.25 KB

This is the documentation of the CERN Neutrino Group. It contains information for newcomers (and current members) and also points them to other useful resources.

How to add new articles:

Clone this repository or use the GitHub online editor directly. To do this, you must have the necessary permissions (i.e. you must be added as a collaborator in the repository- send a message in the Slack channel).

Navigate to the docs directory. It consists of folders and markdown .md files. Each markdown file corresponds to a page on the website. A folder consisting of markdown files creates a dropdown menu with the folder name as the parent tab of the menu.

The ABPComputing docs serves as an example of what our wiki should look like.

There is a great guide in the official mkdocs-material documentation on how to write Markdown files for this framework.

Test locally

To test that your changes are displayed correctly you can install mkdocs-material:

pip install mkdocs-material

Then you can test locally by running:

mkdocs serve