Skip to content

Commit

Permalink
add md lint section to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
slavaleleka committed Aug 10, 2023
1 parent db5b622 commit 6317dbe
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,25 @@ Then you should open Terminal on your computer, navigate to the directory where

- `yarn install`

### Lint markdown

This command lints the markdown and outputs any errors to the console:

- `yarn lint:md`

Some of errors can be fixed automatically:

- `yarn lint:md --fix`

VSCode users can install the [markdownlint extension][vscode-markdownlint] to see the errors in the editor.

### Run it locally

- `yarn start`

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
This command [lints markdown syntax](#lint-markdown),
and if there is no markdownlint errors starts a local development server and opens up a browser window.
Most changes are reflected live without having to restart the server.

## How to build

Expand All @@ -47,3 +61,5 @@ Here's how you can debug translations locally.

1. Download translations: `CROWDIN_PERSONAL_TOKEN="YOURTOKEN" yarn run crowdin download`
2. Run Docusaurus with the language of your choice: `yarn run start -- --locale de`

[vscode-markdownlint]: https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint

0 comments on commit 6317dbe

Please sign in to comment.