Commit graph

88 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
Jonathan Wren
514ee309b8
Add logo to readme (#1085)
* add logo to readme

* update url for image

* rename file to be more clear about where it goes
2020-11-21 11:22:54 -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
joaquin garmendia
8c2de0e6d7
Add display format option to config file. (#1050)
* Add display format option to config file.
* Add tests.
* Fix `black` error.
* Change nested if to top level.
2020-10-17 18:53:34 -07:00
Jonathan Wren
ced8d251d9
Change styling of terminal on docs site, small copy changes (#1038)
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.
2020-09-05 12:07:47 -07:00
Jonathan Wren
29234ddc35
Documentation updates (Thanks @guydebros!) (#1031)
* 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-08-22 12:13:36 -07:00
Dacoda Nelson
5eaf94a18f
Updated advanced.md in docs to reflect all four subkeys under colors in the config files. (#1023) 2020-08-08 11:44:50 -07:00
Jonathan Wren
40a40af952
Fix readthedocs.io build process (#1004)
* fix readthedocs.io build process
2020-07-25 16:34:17 -07:00
Guy B. deBros
ca73c74a8e Extensive modifications to overview.md (#957)
* 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-06-06 12:43:28 -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
Matt Abrams
aad2af1a8d typo in recipes.md (#952)
typo in recipes.md. two verbs in a row. only one is needed :)
cheers
mja
2020-05-16 11:27:52 -07:00
Micah Jerome Ellison
4df4e56a96 Improve privacy, security, and encryption documentation #896 (#925)
* Improve privacy, security, and encryption documentation #896
* Use gentler language and ensuring documentation does not read like legal advice
2020-05-06 18:14:44 -07:00
Micah Jerome Ellison
683a0bac6c Change github new issue link to issue template chooser (#936) 2020-05-05 12:51:03 -07:00
Epskampie
473187f4b8 Docs: editing config isn't always destructive (#923)
Editing the config file doen't always destroy your journal, luckily :-)
2020-04-25 10:31:38 -07:00
Jonathan Wren
333dbca783 Update twitter buttons, contribution in footer (#905) 2020-04-10 16:18:34 -07:00
Micah Jerome Ellison
79d2bd5ec7 Change install doc guideline from pip to pipx and mention minimum Python version 2020-04-10 16:18:34 -07:00
Nathan Genetzky
327af80997 docs: Update url for "beautiful timeline" in export.md (#879)
The previous URL was invalid. Used way back time machine, and at least at some point a redirect was setup to this site.
2020-04-10 11:51:56 -07:00
Aaron Lichtman
9e5d160bbd Pretty print journal entries (#692)
* 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
2020-04-10 11:51:56 -07:00
Aurélien Ooms
1b3d2961a1 docs: Fix fish history instructions.
Use `--add` flag in fish `abbr` command.
2020-04-10 11:51:56 -07:00
Leroy van Logchem
55eff3b777 Update recipes.md
Fixed links to various documentation files
2020-04-10 11:51:56 -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
Jonathan Wren
9acdba1ec7 Update old links (#844)
Since we moved the core repo to jrnl-org, the old links no longer work.
2020-04-10 11:51:56 -07:00
Aurélien Ooms
839ce7d42d Fix typo in encryption docs (#812)
* Explain how fish can be configured to exclude jrnl commands from history by default
* Fix typo in encryption docs
2020-04-10 11:51:56 -07:00
Aurélien Ooms
17ce55e031 Explain how fish can be configured to exclude jrnl commands from history by default 2020-04-10 11:51:56 -07:00
heymajor
7a1ee99863 Updating/expanding template explanation
Smoothing out formatting issues
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
Jesper Kjeldgaard
657eb8fcda Fix merge conflict left-over 2020-04-10 11:51:56 -07:00
Manuel Ebert
58ddee3b49 Display header in mobile docs 2020-04-10 11:51:55 -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
Rory O’Kane
374cae687a In Encryption docs, improve grammar and typography 2020-04-10 11:51:55 -07:00
Greg Bodnar
05234590eb Update docs
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
2020-04-10 11:51:55 -07:00
Greg Bodnar
3a2f155a21 Add recipe to display random entry 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
Emma Humphries
240fb883cc Add instructions for VS Code (#544) 2018-06-26 11:28:23 -07:00
Manuel Ebert
452d99f835 Docs on Alfred integration
Fixes #364
2016-01-11 12:17:59 -08:00
Manuel Ebert
a56d65ca4c Doc update on HISTIGNORE
Fixes #394
2016-01-11 12:11:56 -08:00
Manuel Ebert
f7b7a886c4 Remove references to jrnl[encrypted] 2015-12-28 21:56:08 -08:00
Manuel Ebert
07fbf73dee Fix for #322 2015-04-21 15:49:27 +02:00
Josh Davis
7c3586bbde Add documentation on advanced editor config 2015-04-20 14:45:24 +02:00
Manuel Ebert
9e95edd53c Docs 2014-09-12 14:22:15 -07:00
Manuel Ebert
da17dc9d8a Docs update
Closes #176
2014-07-21 14:58:01 +09:00
Steven Maude
2dcb3f215d Minor typo in installation.rst
Fix "PyCyrypto" to "PyCrypto".
2014-07-12 00:06:11 +01:00
Manuel Ebert
e0a603bcb8 Notes on encryption 2014-06-30 18:00:38 +02:00
Manuel Ebert
5b4e89f081 New make options 2014-06-30 11:14:25 +02:00
Manuel Ebert
be1a90db3d Version bump & new recipes 2014-06-30 10:26:54 +02:00
Manuel Ebert
66ec554637 Link to advanced usage 2014-06-27 14:11:42 +02:00
karl
93b1edff9d Note for editing constraints on one line. FIX #199 2014-06-27 09:12:04 +09:00