Our documentation is built with Material for MkDocs and configured via
mkdocs.yml in the project root.
The docs can be found in the
To build the docs locally, install Material for MkDocs with pip:
In the project root directory run
mkdocs serve to run a local version of the documentation site.
Adding New Pages¶
- Create a Markdown file in the directory of choice
- Add the newly created Markdown file to the
navvalue under the subsection as defined by the file's location in
We typically use the Bootstrap icon set with our projects. This set is quite expansive, and we don't add the entire set into our docs folder as most icons go unused. If you wish to use an icon when writing documentation to refer to an icon present in part of the app, you may have to download the SVG file and add it to the repo.
Icons are placed in the
docs/overrides/.icons/iconsetname/icon-name.svg directory, and can be added in markdown files as
:iconsetname-icon-name: accordingly. For more information, see the Material for MKDocs page on Changing the logo and icons.
Docs Style Guide¶
Webrecorder is a global team but we use American English when writing documentation and in-app copy. Some basic rules to follow are:
- Swap the
zin words like categorize and pluralize.
- Remove the
ufrom words like color and honor.
terin words like center.
- Numbers should be formatted with commas for seperation of values, using periods to denote decimals (e.g: 3,153.89, not 3 153,89).
In a list of three or more items, the list item proceeding the word "and" should have a comma placed after it clarifying that the final item in the list is not a part of the previous item.
|One, two, three, and four.||One, two, three and four.|
|Charles, Ada, and Alan.||Charles, Ada and Alan.|
Avoid using acronyms when reuse is not frequent enough to warrant space savings. When acronyms must be used, spell the full phrase first and include the acronym in parentheses
() the first time it is used in each document. This can be omitted for extremely common acronyms such as "URL" or "HTTP".
When running in a Virtual Machine (VM), use the....
All headings should be set in title case.
Indiana Jones and the Raiders of the Lost Ark
Referencing Features and Their Options¶
Controls with multiple options should have their options referenced as
in-line code blocks.
Setting names referenced outside of a heading should be Title Cased and set in italics.
Actions with text (buttons in the app) should also be Title Cased and set in italics.
Sets the day of the week for which crawls scheduled with a
WeeklyFrequency will run.
Manual Word Wrapping¶
Do not manually wrap words by adding newlines when writing documentation.
Code Block Syntax Highlighting¶
Tag the language to be used for syntax highlighting.
For in-line code blocks, syntax highlighting should be added for all code-related usage by adding
#!language to the start of all in-line code blocks. This is not required for paths or simply highlighting important text using in-line code blocks.
We use Admonitions in their collapsed state to offer additional context or tips that aren't relevant to all users reading the section. We use standard un-collapsable ones when we need to call attention to a specific point.
There are a lot of different options provided by Material for MkDocs — So many in fact that we try to pair down their usage into the following categories.
The default call-out, used to highlight something if there isn't a more relevant one — should generally be expanded by default but can be collapsable by the user if the note is long.
Tip: May have a title stating the tip or best practice
Used to highlight a point that is useful for everyone to understand about the documented subject — should be expanded and kept brief.
Info: Must have a title describing the context under which this information is useful
Used to deliver context-based content such as things that are dependant on operating system or environment — should be collapsed by default.
Example: Must have a title describing the content
Used to deliver additional information about a feature that could be useful in a specific circumstance or that might not otherwise be considered — should be collapsed by default.
Question: Must have a title phrased in the form of a question
Used to answer frequently asked questions about the documented subject — should be collapsed by default.
Warning: Must have a title stating the warning
Used to deliver important information — should always be expanded.
Danger: Must have a title stating the warning
Used to deliver information about serious unrecoverable actions such as deleting large amounts of data or resetting things — should always be expanded.