_style-guide.md

July 5, 2024 ยท View on GitHub

Terminology

  • Use relative paths for child or sibling documents. E.g. images/fig-1.png, pdf-basics.qmd. Avoid using http://quarto.org for internal links.
  • Prefer absolute paths from the root of the project over relative paths involving ../. E.g. use /docs/output-formats/html-themes.qmd, not ../output-formats/html-themes.qmd.
    • Possible exception: documents in a subfolder of a section that link to the section root, e.g. you may use ../index.qmd to refer to docs/manuscripts/index.qmd from docs/manuscripts/authoring/index.qmd.
  • Use .qmd instead of .html. E.g. use content.qmd#editing-tables, not content.html#editing-tables
    • Possible exception: links in blog posts