Markdown uses a very simple formatting syntax to accomplish the same thing that HTML or Rich Text Formatting does. The difference is that it's simpler than HTML and you don't have to worry about opening and closing tags. ... To format text, Markdown uses punctuation and characters you're already familiar with.
Documentation can be authored in markdown or can be converted from several common formats to markdown. The markdown can be used directly on sites where the documentation will be posted (github, bitbucket, visualstudio online, etc.), or it can be converted to html generating a site for users browse.
- MKDocs
- Wordpress
- etc.
Documents created using Helpndoc can also generate web content to be used directly on a website, or it can be saved as word or pdf and converted to markdown for inclusion in this site.
This section will grow as suggestions are added to edit markdown on different platforms. Markdown support is built into VSO and can be edited directly with a basic markdown editor directoy in the source control with preview support.
- MKDocs markdown to website generator (see below).
- Mashable Article on Markdown Tools
- Host a website directly in Github or any web server using MDWiki
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
For full documentation visit mkdocs.org.
mkdocs new [dir-name]- Create a new project.mkdocs serve- Start the live-reloading docs server.mkdocs build- Build the documentation site.mkdocs help- Print this help message.
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
Doxygen suports genrating markdown, see the doxygen manual: Doxygen Markdown Support