Skip to content
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

Add an online Documentation tool to CQP4RDF #27

Open
thesagarsehgal opened this issue Feb 25, 2020 · 0 comments
Open

Add an online Documentation tool to CQP4RDF #27

thesagarsehgal opened this issue Feb 25, 2020 · 0 comments

Comments

@thesagarsehgal
Copy link
Contributor

Currently, the complete documentation is written in the Readme.md and other in docs folder. It would br nice to have an online version of th documentation.

After searching I found MkDocs would be good tool to wite the documentation as we can directly write in Markdown only.
Link to MkDocs:- https://www.mkdocs.org
How to get started with MkDocs:- https://docs.readthedocs.io/en/stable/intro/getting-started-with-mkdocs.html

Further, we can host the documentation online on readthedocs. It offers free hosting of documentation.
Hosting MkDocs documented website on Read The Docs:- https://www.mkdocs.org/user-guide/deploying-your-docs/#read-the-docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant