index.md

VSCodeExtensions Docs

VSCodeExtensions Documentation is using a combination of PlatyPS and ReadTheDocs. This let's you write the command help once and it will create External Help, Github Markdown Help, and Help hosted on ReadTheDocs.

• Help is written in Markdown in the docs folder following a PlatyPS schema.
• It then gets exported into an External Help file VSCodeExtensions-help.xml.
• When committed, ReadTheDocs then uses the mkdocs.yml file to build the Documentation based on the mkdocs.yml layout.

Contributing to Documentation

If you find any corrections, typos or would like to contribute to the Documentation, you can do the following:

• Clone the VSCodeExtensions Repo
• Edit the Documentation Markdown in the the docs folder
• The structure of the Help Markdown Files is described in the mkdocs.yml
• Commit changes and submit a Pull Request.