Manual: We are changing from docbook to markdown

Static source code analysis tool for C and C++ code

Brought to you by: danielmarjamaki

Manual: We are changing from docbook to markdown

Forum: Development

Creator: Daniel Marjamäki

Created: 2019-03-02

Updated: 2019-03-08

Daniel Marjamäki - 2019-03-02

We discussed changing the manual format in the chat. nobody really wanted to have docbook. We want a format that will enable many contributions. The final decision was made today to switch to MarkDown.

A new manual has been added. man/manual.md.

Now.. when writing manual.md I envision that we should use the old manual as an inspiration and copy the good stuff. But then rewrite the parts that needs a rewrite. Please feel free to help out with this work. You can help out with for instance 1 chapter at a time.

I hope there will be more contributions in the manual from now on. :-)

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Alexander Mai - 2019-03-08

Does it make sense to adopt a markdown flavor like GitHub Flavored Markdown due to the enhanced support for code snippets and since the source is hosted there as well?

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Daniel Marjamäki - 2019-03-08

hmm.. that is not a bad idea. does that also allow output to html and pdf?

If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
- Alexander Mai - 2019-03-08
  
  Accoding to google it cna be converted to HTML using github resources or offline using e.g. http://pandoc.org/index.html. The latter offers a couple of different formats, though PDF itself seems to be missing.
  
  If you would like to refer to this comment somewhere else in this project, copy and paste the following link:

Log in to post a comment.