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!
* 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
* 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>
The terminal now overlaps the header (the purple area at the top of the
page) and the main area (the white area underneath). This draws more
focus to it, and quite literally puts the terminal front and center.
This also fixes a few typos, and updates the commands in the terminal to
match jrnl v2.5 updates.
* 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>
* 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
* 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...
* Pretty print journal entry titles and dates.
Changes appearance of all jrnl viewing commands, such as $ jrnl --short and
$ jrnl -n {NUM}.
Fix#508
* Removed extra newline at end of title
* Use ansiwrap to properly wrap strings with ANSI escapes
* Add ansiwrap to pyproject.toml
* Allow configuration of colors
- Replaced raw escapes with colorama
- Added colors key to config
- Add checks for validity of color values
* Add color configuration documentation
* Fix broken tests due to config change
* Add tests for colors in configs
- Identifying invalid color configs
- Upgrading config from no colors -> colors
* Add colorama dependency for all platforms
* Allow users to disable colorization of output
* Update poetry.lock
* Add tag and body color customization options
* Fix colorization of tags in title and body
* Updated tests to use no color by default
* Change pass to continue in verify_config()
* Better style in Entry.py
* Reduce code duplication for tag highlighting
- Breaks "unreadable date" regression test for unknown reason
* Properly colorize tags and print body
* Reformatting and clean up
* Replace list comprehension with generator
* Handle invalid colors by not using a color
* Process ANSI escapes properly with behave
* Fixed the 'spaces after tags directly next to punctuation' bug
Broke processing of tags next to any punctuation at all
* Closer to working tag colorization but not perfect
* Add tests printing for multiline journals
Fix#717
* Correctly indent first line of multiline entry
* Add test for multiline entries with tags
* Remove redundant UNICODE flag
* Progress towards proper tag colorization and body formatting
* Fix newline colorization bug
Debug code left intact since there are more bugs to fix :/
* And now the space just ends up before the tag instead of after it
* Fix assertion syntax warning
* Moved tag test to tagging.feature file
* Strip out debug code and clean up
* Bold datetimes in title
* Bold all titles
Fix#720
* Remove PY2 and PY3 constants
* Fix regression in features/steps/core.py
* Fix tag_regex
* Remove redundant re.UNICODE flag
* Remove extraneous code
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.
Add doc about extracting timestamps with no spaces
Timestamp formats may have no space between date and time components and
cause the script to fail.
In Encryption docs, explain how to prevent Fish history logging
