This is the repository for the QuanTOR website at quantor-project.github.io hosted via Github Pages.
- Individual pages of the site are created as Markdown files in the
doc/
subdirectory. They use GitHub-flavoured Markdown and allow inline HTML for advanced formatting. - To navigate between pages, just specify the target Markdown filename as a hyperlink, e.g.
meet our [team](team.md)
. Page titles and ordering in the sidebar are determined by fieldstitle:
andorder:
in the YAML frontmatter of each page. - Images and files should be stored in subdirectory
doc/data
and can be included with relative hyperlinks. - After pushing updates to the GitHub repository, the website is automatically rebuilt by a GitHub action. This may take a few minutes, depending on available computing resources.
- Alternatively, pages can also be edited directly in the GitHub repository using the Web-based editor.
- If you are editing a local clone of the GitHub repository and want to test changes before committing and pushing them, you can run a local server with the shell script
docs/_local_preview.sh
. Make sure that Ruby is available on your computer, then change to thedocs/
directory and run./_local_preview.sh
.