Commit graph

10 commits

Author SHA1 Message Date
Micah Jerome Ellison
c5729420a4
Comply with GPL by acknowledging all authors and including license info in 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-12-19 14:53:15 -08:00
Manuel Ebert
e03021a94c
Fixes lone closing parenthesis in docs (#1118)
Look, this might me my least ambitious commit ever, but having mismatched parentheses has crashed the internet before, so let's rather be safe than sorry!
2020-12-15 17:50:00 -08:00
Jonathan Wren
558d331d66
Make docs site (jrnl.sh) fully meet Web Content Accessibility Guidelines (WCAG) 2.1 (#1105)
* add some attribtutes to docs template for accessbility

* fix colors to meet accessibility guidelines (4.5 contrast ratio for text)

* Fix last remaining pa11y error (no button on search form)

This fix required moving the mkdocs theme out of the docs directory.
It's no in the docs_theme directory, and the mkdocs config is updated
accordingly.

* Re-enable accessibility testing for docs sit

Also, move the pa11y script into the gh actions workflow

* clean up linting issues in css

* fix and standardize link colors across site

* fix twitter button opacity making text fail contrast requirements

* move buttons on docs site index nav, tweak font weights

* fix footer opacity, tweak spacing of the now more visible sections of the page

* change font sizes on index page to meet WCAG

* udpate font sizes site-wide for accessibility

* fix sidebar for accessibility (font sizes and color contrasts)

* restyle code blocks to have dark background, and meet accessibility requirements

* standardize (accessible) colors across docs site
2020-12-12 12:05:12 -08:00
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
Guy B. deBros
ce0dd6881c Cleaned up usage.md for clarity, formatting, and grammar. (#956)
* Cleaned up usage.md for clarity, formatting, and grammar.

While working on it, I hard-wrapped the lines to 80 characters. Hope that doesn't complicate things.

Note: I changed the Steve Buscemi quote to maintain compliance with the Code of Conduct.

* more changes to the usage page

Includes information about two new functions (`--delete`) and (`-contains`).
It's starting to look quite different from the original...
2020-05-27 14:07:43 -07:00
Jonathan Wren
4190494a4f Get rid of dumb sex joke (#840)
These kinds of jokes make us look bad, and have gotten this project bad
PR on social media. It's best to get rid of them. We can still be super
glib and funny without crass jokes.
2020-04-10 11:51:56 -07:00
Eshan
af6243c73d Fix usage notes
Notes were correctly indented.
2020-04-10 11:51:56 -07:00
Micah Jerome Ellison
47310f71a1 [GH-666] updating documentation to reflect v2 behavior:
* new config location and file type
* removing mentions of DayOne support
* removing mention of pip install jrnl[encrypted]
2020-04-10 11:51:55 -07:00
Manuel Ebert
328faa401c Smaller doc fixes, fixes #486
Found and removed another angsty teenager
2020-04-10 11:51:55 -07:00
Manuel Ebert
b7e077be68 Moving from sphinx to mkdocs
Cleaning up docs
Lighter side bar
Landing page refresh
Add JSON-LD and semantic tags
2020-04-10 11:51:55 -07:00