Skip to content

Latest commit

 

History

History
49 lines (40 loc) · 2.13 KB

README.md

File metadata and controls

49 lines (40 loc) · 2.13 KB
Raw

Qubes OS Documentation

Canonical URL: https://www.qubes-os.org/doc/

All Qubes OS Project documentation pages are stored as plain text files in this dedicated repository. By cloning and regularly pulling from this repo, users can maintain their own up-to-date offline copy of all Qubes documentation rather than relying solely on the Web. Contributions to the documentation (both new content and edits of existing content) are welcome. To contribute, please fork and clone this repo, make your changes, then either submit a pull request or send a patch to the qubes-devel mailing list. If you have a GitHub account (free), you can simply browse this repository and edit the files here. The GitHub interface will automatically guide you through the fork and pull request process.

Markdown Conventions

All the documentation is written in Markdown for maximum accessibility. When making contributions, please observe the following style conventions:

  • Use spaces instead of tabs.
  • Hard wrap Markdown lines at 80 characters.
  • Hard wrap Git commit message lines at 72 characters.
    • This leaves exactly four spaces on each side of the commit message when viewed in the default git log format.)
  • If appropriate, make numerals in numbered lists match between Markdown source and HTML output.
    • In the event that a user is required to read the Markdown source directly, this will make it easier to follow, e.g., numbered steps in a set of instructions.
  • Use hanging indentations
    where appropriate.
  • Use underline headings (===== and -----) if possible. If this is not possible, use Atx-style headings on both the left and right sides (### H3 ###).
  • Use [reference-style][ref] links.

[ref]: http://daringfireball.net/projects/markdown/syntax#link