summaryrefslogtreecommitdiffstats
path: root/docs/overview.md
AgeCommit message (Collapse)Author
2020-12-19Comply with GPL by acknowledging all authors and including license info in ↵Micah Jerome Ellison
each source file (#1121) * Update authors to "jrnl contributors" to comply with GPL3 * Include jrnl email address with contributors * Include GPL notice in jrnl --version * Apply consistent copyright and license to all Python files * Add copyright and license to documentation * Add copyright and license to docs theme * Wiping poetry cache to try to resolve a test issue * Testing with Python 3.9.0 in attempt to bypass GitHub Actions failure in 3.9.1 * make format * Exclude Windows Python 3.9 build which is failing due to a GitHub Actions problem * Modify testing to get around this 3.9 issue... * Fix exclude
2020-10-24Documentation updates (#1032)Micah Jerome Ellison
* 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 13b4266ed1e7150ef5a2235a2f816333692b71f2. * 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-08-22Documentation updates (Thanks @guydebros!) (#1031)Jonathan Wren
* updated README.md: - corrected information about encryption - made additions based on proposed changes to overview.md - made other changes for clarity and grammar * ongoing changes to overview.md * added note that `pycrypto` is required made other small changes for grammar and clarity * added new python decryption script to encryption.md * updated encryption.md to clarify dependencies other relatively small changes for clarity straightened quotes Co-authored-by: Guy B. deBros <guydebros@users.noreply.github.com>
2020-06-06Extensive modifications to overview.md (#957)Guy B. deBros
* Extensive modifications to overview.md. I tried to add clarity and details while maintaining the spirit of the original document. However, it might be a bit too 'dry' now. I'd be happy to liven it up a bit. I'm only serious when I feel like I _have_ to be. One of my opinions (which may be at odds with yours) is that the documentation should emphasize `jrnl`'s advantages without downplaying any other existing solutions. If I have time, I'd like to add more information about the documented benefits of journaling, particularly the mental health aspects. That will probably need its own page, but I'm new here, so I don't want to overstay my welcome. :) * More changes to overview.md in response to feedback "why keep a journal" section removed -- it could be re-added as its own page, but it's not front-page material * More changes to overview.md: - fixed up the headings - added information about multi-platform support This is a work in progress and _not_ ready for prime-time. - need to add to Command-Line Interface section, among other things * More changes to overview.md: - moved "`jrnl` is a simple..." to "Command-Line Interface" section
2020-04-10[GH-666] updating documentation to reflect v2 behavior:Micah Jerome Ellison
* new config location and file type * removing mentions of DayOne support * removing mention of pip install jrnl[encrypted]
2020-04-10Smaller doc fixes, fixes #486Manuel Ebert
Found and removed another angsty teenager
2020-04-10Moving from sphinx to mkdocsManuel Ebert
Cleaning up docs Lighter side bar Landing page refresh Add JSON-LD and semantic tags