fz0x1/jrnl
1
0
Fork 0
mirror of https://github.com/jrnl-org/jrnl.git synced 2025-05-18 12:08:31 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

mdless recipe changes during review

Browse source 
-condense language
-make it sound less like an endorsement
-add link about less
-minor grammatical change
This commit is contained in:
Micah Jerome Ellison 2021-10-16 13:39:44 -07:00
parent 95d53a7b84
commit 2ce4bbaa63
1 changed files with 2 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/recipes.md
View file

@ -182,9 +182,7 @@ for_window[title="floating *"] floating enable
```
### Visualize Formatted Markdown in the CLI
Out of the box, `jrnl` can output journal entries in Markdown. However, in order to visualize it you often need to resort to an external Markdown visualizer on your Desktop. But what if you could render your Markdown straight from the CLI? [mdless](https://github.com/ttscoff/mdless) and piping is the answer.
`mdless` is a `less` like tool that allows you to visualize your Markdown text with formatting and syntax highlighting from the CLI. You can use this in any shell that supports piping. In Linux/Unix any shell supports this, but on Windows you will have to use `PowerShell` or an alternative one that supports piping.
Out of the box, `jrnl` can output journal entries in Markdown. To visualize it, you can pipe to [mdless](https://github.com/ttscoff/mdless), which is a [less](https://en.wikipedia.org/wiki/Less_(Unix))-like tool that allows you to visualize your Markdown text with formatting and syntax highlighting from the CLI. You can use this in any shell that supports piping.
The simplest way to visualize your Markdown output with `mdless` is as follows:
```sh
@ -193,7 +191,7 @@ jrnl --export md | mdless
This will render your Markdown output in the whole screen.
Fortunately `mdless` has an option that allows you to adjust the screen width by using the `-w` option as follows:
Fortunately, `mdless` has an option that allows you to adjust the screen width by using the `-w` option as follows:
```sh
jrnl --export md | mdless -w 70