-
Notifications
You must be signed in to change notification settings - Fork 11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Decide upon unified documentation system #3
Comments
Having looked at the different systems a bit, I think asciidoc and docutils/reST would be the most reasonable candidates since they provide a straightforward markdown style syntax. Some examples and the available output formats: reST: HTML, HTML5, S5, LaTeX, XML(Docutils), OpenOffice ODF/.odt
asciidoc: HTML, XHTML, EPUB, PDF, DVI, PostScript, roff, man pages, Web help, HTML Help, additional user output formats example: http://asciidoc.org/book.txt To me, asciidoc looks a bit more mature and supported, is a bit more expressive but also less straight-forward to write. Docbook/RST is described in its documentation as still a bit experimental but seems to get adopted by many platforms right now such as Trac and GitHub. I think either one would do the job, but I would, for now, try asciidoc first, since there seems to be more widespread tool support and more backends/generators, also I subjectively feel it's better suited for a larger, structured document such as a user guide with different chapters and such. I have no experience with either of them, so this is more of a gut feeling. Any comments, experiences? |
Yes, my preference goes to asciidoc as well. Lets just go with it, put some documentation into this format and see how it feels after we have worked with it for a while |
example and AsciiDoc cheatsheet : http://powerman.name/doc/asciidoc |
Close, continue under #76 |
* move "delete anim" and "enable anim" button to top (resolve disabled btn on delete)
* move "delete anim" and "enable anim" button to top (resolve disabled btn on delete)
* move "delete anim" and "enable anim" button to top (resolve disabled btn on delete)
We want some unified documentation system which preferrably:
Possible choices:
The text was updated successfully, but these errors were encountered: