Home

Welcome to the yadism wiki!

This wiki is mainly used for development purposes, so it is a place where members of development team should look into for instructions, and where storing records about known bugs in codes we are benchmarking against.

Local wiki

It's fine to edit the wiki locally instead that from the web interface. In order to do this just clone it's repo (it's separate from the code one). For example for this repo just do:

git clone git@github.com:N3PDF/yadism.wiki.git

Awesome!

Manage sidebar

Change priority

Modify the sidebar/priority.yaml file, valid keys are names of files (only the base name, stripping any subdirectory) or folders (only the folder, not the path), values are numbers, the higher it will be the sooner it will appear.

Sidebar commit hook

In order to be sure that the sidebar is always compiled add a pre-commit hook to the .git repo running the following commands in repo root:

echo '#!/bin/sh\npython3 sidebar.py\ngit add _Sidebar.md' > pre-commit
chmod 775 pre-commit
mv pre-commit .git/hooks/