pidgin/nest

Format readme

2019-06-12, Jason
a70eaad36ef9
Parents 24a53d8dff62
Children 65e8d6d0d50b
Format readme
1 files changed, 20 insertions(+), 13 deletions(-)
  • +20 -13
    readme.md
    • --- a/readme.md Wed Jun 12 03:38:13 2019 +0100
    +++ b/readme.md Wed Jun 12 03:41:39 2019 +0100
    @@ -4,22 +4,26 @@
    ## Table of contents
    -- [Community](community.md)
    -- [Contributing](contributing.md)
    -- [Design Guidelines](design-guidelines.md)
    -- [Development FAQ](development-faq.md)
    -- [Release Process](release-process.md)
    +- [Community](community.md)
    +- [Contributing](contributing.md)
    +- [Design Guidelines](design-guidelines.md)
    +- [Development FAQ](development-faq.md)
    +- [Release Process](release-process.md)
    ## Dependencies
    -This project uses [hugo](https://gohugo.io/), get it [here](https://gohugo.io/getting-started/installing/)
    +This project uses [hugo](https://gohugo.io/), get it
    +[here](https://gohugo.io/getting-started/installing/)
    ## Developing Docs
    -To start devleopment server run: `hugo server -s hugo -D --disableFastRender -v --verboseLog --noHTTPCache --i18n-warnings`
    +
    +To start devleopment server run:
    +`hugo server -s hugo -D --disableFastRender -v --verboseLog --noHTTPCache --i18n-warnings`
    - - `--disableFastRender` Disabling fast render is needed because hugo starts to ignore new content in the data dir
    - - `-v --verboseLog` Better logging and debugging experience
    - - `--noHTTPCache` To prevent caching issues
    +- `--disableFastRender` Disabling fast render is needed because hugo starts to
    + ignore new content in the data dir
    +- `-v --verboseLog` Better logging and debugging experience
    +- `--noHTTPCache` To prevent caching issues
    ## Docker
    @@ -38,10 +42,13 @@
    ## Hugo config
    -To disable **Copy Code to Clipboard** the `disableInlineCopyToClipBoard` switch can be used either in **config** `[params]` **or** in the front matter of the individual page
    +To disable **Copy Code to Clipboard** the `disableInlineCopyToClipBoard` switch
    +can be used either in **config** `[params]` **or** in the front matter of the
    +individual page
    ## Tools
    -* **Visual Regression**
    +- **Visual Regression**
    1. [Run dev server](#Developing-Docs)
    - 1. To run the visual diff tool call `node tools/visual-diff.js` or `npm run regression`
    \ No newline at end of file
    + 1. To run the visual diff tool call `node tools/visual-diff.js` or
    + `npm run regression`