ctome
/
tldr
mirror of https://github.com/CrimsonTome/tldr.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

style-guide.md: add tip to view file locally (#1928)

coverage
Colin 2018-01-30 01:15:22 -05:00 committed by Agniva De Sarker
parent 4e245b2b17
commit c93f4b96f5
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
contributing-guides/style-guide.md
View File

@ -33,6 +33,12 @@ tldrl -f {{page.md}}
For other ways to use `tldrl`, such as linting an entire directory, check out (what else!)
[`tldr tldrl`](https://github.com/tldr-pages/tldr/blob/master/pages/common/tldrl.md)
If you're using the Node.js client of `tldr`, you can preview a page locally using the `-f` flag (aka `--render`):
```
tldr -f {{page.md}}
```
## Token syntax
User-provided values should use the `{{token}}` syntax
@ -58,4 +64,4 @@ Keep the following guidelines in mind when choosing tokens:
For example, use `iostat {{2}}` rather than `iostat {{interval_in_secs}}`.
In general, tokens should make it as intuitive as possible
to figure out how to use the command and fill it in with values.
to figure out how to use the command and fill it in with values.