User-friendly documentation

[itviewer]

As the project becomes more and more popular, well-organized documents are necessary. Up to now, the project uses the README file to describe how to use the library, with the some disadvantages:

• with the description more and more, README file becomes very long
• the user needs a clearer structure to describe how to use the library
• inconvenient documentation contribution and collaboration

So I suggested to separate the document and the code library to provide a more friendly document experience. I created two styles of demo based on mkdocs:

1. https://itviewer.github.io/manual-material/
2. https://itviewer.github.io/manual/

repository corresponding respectively

1. https://github.com/itviewer/manual-material
2. https://github.com/itviewer/manual/

I just copyed the content from the README file and did not modify anything. both the above two demo looks ok. The markdown syntax for github is good, almost no error format.

The mkdocs tool is a python package, also easy to use, powerful and flexible.

[nlohmann]

FYI: https://nlohmann.github.io/json/

[nlohmann]

Such a documentation looks nice, but there is already a lot of documentation in Doxygen format, including live examples. I would like to generate a documentation out of this to not risk diverging the "reality" and the documentation. Admittedly, the Doxygen documentation is rather ugly...

[itviewer]

https://nlohmann.github.io/json/ is suitable for API reference

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.