Add Markdown linting (#52)
- Also renames `make vale` to `make check` - Addresses a part of #15
This commit is contained in:
parent
5f7f5736ed
commit
b903d962d3
@ -14,7 +14,10 @@ RUN apt-get -y update && apt-get -y install gpg emacs curl \
|
|||||||
|
|
||||||
WORKDIR /usr/src
|
WORKDIR /usr/src
|
||||||
COPY package.json package-lock.json* ./
|
COPY package.json package-lock.json* ./
|
||||||
RUN npm ci && npm cache clean --force && rm -f package.json package-lock.json*
|
RUN npm ci \
|
||||||
|
&& npm install -g markdownlint-cli \
|
||||||
|
&& npm cache clean --force \
|
||||||
|
&& rm -f package.json package-lock.json*
|
||||||
ENV PATH /usr/src/node_modules/.bin:$PATH
|
ENV PATH /usr/src/node_modules/.bin:$PATH
|
||||||
|
|
||||||
WORKDIR /usr/src/docs
|
WORKDIR /usr/src/docs
|
||||||
|
|||||||
@ -8,9 +8,11 @@ dev:
|
|||||||
-p 3000:3000 \
|
-p 3000:3000 \
|
||||||
-v ${PWD}:/usr/src/docs alcion/docs
|
-v ${PWD}:/usr/src/docs alcion/docs
|
||||||
|
|
||||||
vale:
|
check:
|
||||||
docker run --rm \
|
docker run --rm \
|
||||||
-v ${PWD}:/usr/src/docs alcion/docs vale --glob='*.md' .
|
-v ${PWD}:/usr/src/docs alcion/docs vale --glob='*.md' .
|
||||||
|
docker run --rm \
|
||||||
|
-v ${PWD}:/usr/src/docs alcion/docs markdownlint '**/*.md'
|
||||||
|
|
||||||
shell:
|
shell:
|
||||||
docker run --rm -it \
|
docker run --rm -it \
|
||||||
|
|||||||
@ -24,6 +24,14 @@ $ make build
|
|||||||
|
|
||||||
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
||||||
|
|
||||||
|
### Check Docs
|
||||||
|
|
||||||
|
```
|
||||||
|
$ make check
|
||||||
|
```
|
||||||
|
|
||||||
|
This command will lint all Markdown files and check them for style issues.
|
||||||
|
|
||||||
### Documentation Platform Development
|
### Documentation Platform Development
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user