jrnl/mkdocs.yml
Micah Jerome Ellison 5b029e6117
Documentation updates (#1032)
* Applying doc changes based on reviews of past several documentation PRs
* Update docs
  Clean up encryption docs
  Clean up security docs
  Delete export.md
  Make new formats.md and add to sidebar. Also add all of the built-in formats, and examples for each.
  Update mkdocs config for new files

* Fix broken docs links
* Correct incomplete sentences and markdown formatting issues
* Make overview a little more concise
* Update some command line arguments to latest version and make it a bit more concise
* Clean up unneeded TOML modifications and other scaffolding not needed for 3.9
* Revert "Clean up unneeded TOML modifications and other scaffolding not needed for 3.9"
  This reverts commit 13b4266ed1.
* Specify that brew is also the easiest way to install jrnl on Linux
* Update docs/security.md
* Update docs/recipes.md
* Doc updates:
- Remove import/export page, fold it into formats
- Rename security to privacy-and-security.md to avoid conflation w/ github security issues
- Various small cleanup and edits from PR review

Co-authored-by: Jonathan Wren <jonathan@nowandwren.com>
2020-10-24 15:41:58 -07:00

25 lines
700 B
YAML

site_name: jrnl
theme:
name: readthedocs
custom_dir: docs/theme
static_templates:
- index.html
extra_css:
- https://fonts.googleapis.com/css?family=Open+Sans:300,600
- assets/theme.css
- assets/highlight.css
markdown_extensions:
- admonition
repo_url: https://github.com/jrnl-org/jrnl/
edit_uri: edit/develop/docs/
site_author: Manuel Ebert
site_description: Collect your thoughts and notes without leaving the command line.
nav:
- Overview: overview.md
- Quickstart: installation.md
- Basic Usage: usage.md
- Encryption: encryption.md
- Privacy and Security: privacy-and-security.md
- Formats: formats.md
- Advanced Usage: advanced.md
- Recipes: recipes.md