We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 428c58b commit d701fcdCopy full SHA for d701fcd
doc/README
@@ -0,0 +1,13 @@
1
+The markdown docs are only generated by make when node is installed (use
2
+`make doc`). If you don't have node installed you can generate them yourself.
3
+Unfortunately there's no real standard for markdown and all the tools work
4
+differently. pandoc is one that seems to work well.
5
+
6
+To generate an html version of a doc do something like:
7
+pandoc --from=markdown --to=html --number-sections -o build/doc/rust.html doc/rust.md && git web--browse build/doc/rust.html
8
9
+The syntax for pandoc flavored markdown can be found at:
10
+http://johnmacfarlane.net/pandoc/README.html#pandocs-markdown
11
12
+A nice quick reference (for non-pandoc markdown) is at:
13
+http://kramdown.rubyforge.org/quickref.html
0 commit comments