canonical / canonical/sphinx-stack-docs

[Docs] missing instructions to set up vale-ignore for md

Open
#10 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
No language data
Stars
4
Forks
11
Avg merge
13d 16h
Merged PRs (30d)
2

Description

I discovered while trying to use the `vale-ignore` role (which is mentioned in the docs) to ignore a single use of the word "manpage", which I don't want to add to the custom word list, that it's not set up by default for markdown and the instructions only mention setting it up for rst. It would be nice to have the corresponding conf.py snippet in markdown as well as rst.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.