Contribute to the docs

How to add a new page to the documentations site using Quarto?

How to contribute?

Make a new branch of the repository

git checkout -b <branch-name>

Make a new .qmd (q-markdown) file in the /docs folder

To the .qmd file add a YAML header with a title and subtitle.

---
title: Contribute to the docs
subtitle: "How to add a new page to the documentations site using Quarto?"
---

Add a link to your file to the _quarto.yml config file in /docs

Open the _quarto.yml configuration file and find the sidebar config code.

sidebar:
  - id: nav
    style: "floating"
    collapse-level: 3
    align: left
    contents:

Under the contents: object add a new section (if required), a string lable for your page, and a link to the .qmd file itself.

- section: "tutorials"
  contents:
    - text: "Reproducible Analytical Pipelines"
      file: tutorials/intro-to-rap.qmd

Publish your changes to GitHub

Render Quarto before publishing

Remember to render your changes locally using R-Studio (or VScode) before publishing

Commit your changes locally

git commit -m 'Added new page to docs'

Then push your changes to the remote branch

git push origin <branch-name>

Finally, open a Pull Request (PR) https://github.com/nhs-pycom/nhspy-plotthedots/pulls