This repository contains the source of Anki's user manual.
This manual is licensed under the CC BY-SA 4 license.
Contributions are welcome! Please see the issue tracker for things you can start working on. For details on local development, see CONTRIBUTING.
Unless stated otherwise, any pull requests you submit will be licensed under the CC BY-SA 4 license.
In 2024, we began efforts to standardize the styles used throughout the documentation. You will probably find that following conventions are not consistently applied in the manual, but these are the rules we are using going forward. If you are submitting edits or updates, please follow these guidelines, and you are welcome to update other text to fit these guidelines as well.
- Use double quotes,
", instead of single quotes,'. - For emphasis, such as when defining a word, use italics,
_. - Also use italics when referring to a word itself rather than what it means, e.g. "To search for either dog or cat, use
dog or cat". - When referring to UI elements, use bold formatting,
**. - When referring to keyboard buttons, wrap them with
<kbd></kbd>. - Use code formatting for example inputs by wrapping them with backticks,
`.
We often use anchor links to direct users to the specific section of a page that will be most useful to them. These anchor links are created from section headers, e.g., https://docs.ankiweb.net/deck-options.html#timers.
If you are submitting a PR that changes or deletes a section header, please add a hidden anchor so those legacy anchor links will continue to function correctly.
Example: To change the header "Clocks" to "Timers" -- replace:
## Clocks
with:
## Timers
<a id="Clocks"></a>
If you are submitting a PR that results in a page being removed from the manual or FAQ entirely:
-
Remove that "chapter" from the SUMMARY in the manual [or FAQ: SUMMARY].
-
Consider whether the link should be redirected to a new location for that documentation, or fail with a 404 error. If it should be redirected, add an entry to the
[output.html.redirect]section of book.toml in the manual [or FAQ: book.toml].- Example:
"old-page-name.html" = "new-page-name.html" - See the mdBook Documentation.
- Example:
