Skip to content

How to document

General

  1. Do not use absolute routes in the internal links, use index.html instead /index.html.
  2. All pages in the root http...site/subsite/<aquí>.html.
  3. Recommended markdown (harp allows more than one).
  4. HarpJs, Bootstrap 5.1, Prism, ... are used.
  5. If a issue in other software is detected, the other software's source must be consulted, so only a reference to the software in documentation is needed.

Steps

  1. Create the file~/src/<new-content>.md.
  2. Add a menu item in ~/src/_data.json.
json
{
  "menu": {
    "Home": "index.html",
    "Documentar": "doc.html",
    ...
    "<title>": "<new-content>.html",
    ...