nn_builder icon indicating copy to clipboard operation
nn_builder copied to clipboard

Published 20 hours ago • verified publisher icon p-christ

Documentation site

Open p-christ opened this issue 6 years ago • 4 comments

We need a site to host documentation for the module. This could potentially be done with GitHub Pages

p-christ avatar May 30 '19 18:05 p-christ

There are multiple tools to create your documentation. Do you have any specific tool in mind?

TannerGilbert avatar Oct 18 '19 06:10 TannerGilbert

Hi! I don't really know about the available tools, are there any you'd recommend?

p-christ avatar Oct 18 '19 08:10 p-christ

For creating a documentation website there are many tools available: docsify, Docusaurus, VuePress, Sphinx.

I have experience in VuePress but I'm sure I could get the other ones to work as well. Regarding hosting all of them can be hosted as a static page on Github Pages or any other hosting platform

TannerGilbert avatar Oct 20 '19 07:10 TannerGilbert

I would recommend Mk-Docs Material. It creates a very clean, searchable and styling is customisable. You can also host it as a static site on GitHub Pages.

kbaran1998 avatar Jan 27 '23 13:01 kbaran1998