markdown lint

[ZinkLu]

Since we have a spell check, should we take markdown lint into consideration?

In #17 (disscuss in chinese) @miss85246 said a we should lint on markdown files.

As far as I am concerned, markdown syntax has different standard and the doc has some vuepress syntax, like ::: block.

I think the markdown is fine as long as the vuepress can render it.

Or should we make basic rule on markdown writing such as a blank line between two content line.

Any thoughts?

[ahopkins]

I'm happy to add a liter. Consistency is always good. I'm not sure if there is anything specific to handle the custom stuff that vuepress adds. If you find something, feel free to test it out and add it.

I plan to mess with the spelling soon.

[miss85246]

I think we should work out a document specification code after released v21.3. This helps:

1. All documents are displayed in a consistent format.
2. Provide writing specifications for document creators.
3. Avoid unnecessary work by document translators.
4. Become a lighthouse for new contributors.
5. Provide reference for new language translators.

In addition, we should also make a translation dictionary to ensure the consistency of proper nouns for different languages.

At present, the codes included in our document are: nginx code and python code. The syntax involved are: python, nginx, vuepress and markdown.

We should make detailed writing and translation rules for these contents, And I think it's should be our 2021
development direction.

This is my idea. If there is anything left out, please say it. 🤔

[ahopkins]

This is a wonderful idea. I am certainly a bit worried about how we can make sure the documentation does not get out of sync in multiple languages.

Outside of this, a set of guidelines makes total sense. Would you like to take a first swing at putting something together? Or, at least doing a survey of some other projects to see what others might be doing?

Which reminds me, our contribution guidelines on the sanic repo need an update. I will probably try and work on that this week.