Documenting Arduino Projects

Came across this site a few days ago, it builds websites from "Mark Down" text.

The sites can then be uploaded to github and make good documentation.

http://www.mkdocs.org/

Here is just a 'demo/test' site I made in about 3 mins and pushed to github.

http://kd8bxp.github.io/Arduino-Projects/

(I am in the process of updating this with all of the projects here)

Making the "mark down" text is easy, and the mkdoc app makes it look nice!

https://guides.github.com/features/mastering-markdown/

Mkdocs - "Mark Down" -

http://www.mkdocs.org/user-guide/configuration/

Make Docs is a fast, simple static site generator, that’s geared towards building project documentation.

Written in Markdown, and configured with a single YAML configuration file.

Easy to use, and fast to generate a professional looking site with documents.

Projects hosted on github, “come with” pages - and the files generated by Mkdocs can be used as these pages.

https://pages.github.com/

Mkdocs even makes it easy to push (while it’s creating) the documents to github.

http://www.mkdocs.org/#deploying

If you don’t want to use Github to host your documents - that’s ok too, the site generated is static, and should work on anything that can host a site (I didn’t have much luck getting to work with google sites thou)

This site directly supports documents from github and others:

https://readthedocs.org/

Git hub has a 3 min (read) tutorial on using “Github Markdown”

https://guides.github.com/features/mastering-markdown/

and mkdocs has some additional things specifically for it:

http://www.mkdocs.org/user-guide/configuration/

As I said once before there is also something called: Gitbook

which can generate books from various types of files, Markdown is one.

http://www.gitbook.com

There are a couple (more than a couple) online Word (and others) coverters that will convert a file to markdown. Mkdocs can use those files to build a website.

Here are a couple I tried:

http://word-to-markdown.herokuapp.com/

http://dillinger.io/

WIKIs are another alternative for Documentation projects:

Here are a few that have free accounts, I’ve not tried any of them.

https://wiki.wiki/

https://meta.miraheze.org/wiki/Miraheze

http://tiddlyspot.com/

http://www.shoutwiki.com/w/index.php?title=Special%3ASearch&search=arduino&fulltext=

Markdown style guides/Formatting guides

General guides for using Markdown, not all markdown sites support all the codes, but most follow simuliar styles.

Github Flavored Syntax
Pivotal Tracker Formatting your Text with Markdown
Markdown Table Generator

Google Sites

Google Sites also has a couple of templates that are good for documenting.

Here are a couple of DEMO sites I made - and to make changes to them is easy in the online editor:

https://sites.google.com/site/demokd8bxp/ (good basic site)

https://sites.google.com/site/kd8bxpwiki/ (Much like a wiki, and easy to add, change and update)