diff --git a/contributing-guides/style-guide.md b/contributing-guides/style-guide.md index 7989d3bfe..bcbad14fa 100644 --- a/contributing-guides/style-guide.md +++ b/contributing-guides/style-guide.md @@ -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. \ No newline at end of file +to figure out how to use the command and fill it in with values.