Browse Source

docs: add docs for vale

friedger-patch-1
Alexander Graebe 4 years ago
committed by Alexander Graebe
parent
commit
1628b7b617
  1. 8
      README.md
  2. 2
      package.json
  3. 8
      src/pages/ecosystem/contributing.md

8
README.md

@ -10,6 +10,14 @@ If you are interested in contributing to the site and making changes, please ref
## Generated documentation
## Style checks
This repository uses [vale](https://github.com/errata-ai/vale) to run style checks. Make sure to install the tool and run the following command before creating a PR in order to check for styling issues:
```bash
yarn vale:check
```
### Blockstack CLI reference
The `src/_data/cli-reference.json` file is generated from the `stx` subcommand `docs`.

2
package.json

@ -121,7 +121,7 @@
"dev": "yarn clean:build-files && next dev",
"build:cli-reference": "stx docs > src/_data/cli-reference.json",
"export": "next export",
"lint": "yarn lint:eslint && yarn lint:prettier",
"lint": "yarn lint:eslint && yarn lint:prettier && yarn vale:check",
"lint:eslint": "eslint \"src/**/*.{ts,tsx}\" -f unix",
"lint:fix": "eslint \"src/**/*.{ts,tsx}\" -f unix --fix",
"lint:prettier": "prettier --check \"src/**/*.{ts,tsx,md,mdx}\" *.js",

8
src/pages/ecosystem/contributing.md

@ -177,6 +177,14 @@ fetch external data at runtime and use it in some way within our pages.
## Tips and tricks
### Style checks
We use the [Google Developer documentation style guides](https://developers.google.com/style/) in this project. Make sure to install [vale](https://github.com/errata-ai/vale) and run the style checks before you create a PR:
```bash
yarn vale:check
```
### Always use Markdown when possible
It's possible to write standard HTML when writing in Markdown, but that should be avoided at all costs. We use `remark` to

Loading…
Cancel
Save