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.

Sign up for GitHub

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

Jump to bottom

Documentation site #7

Open
p-christ opened this issue May 30, 2019 · 4 comments
Open

Documentation site #7

p-christ opened this issue May 30, 2019 · 4 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@p-christ
Copy link
Owner

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

@p-christ p-christ added good first issue Good for newcomers help wanted Extra attention is needed labels May 30, 2019
@TannerGilbert
Copy link

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

@p-christ
Copy link
Owner Author

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

@TannerGilbert
Copy link

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

@kbaran1998
Copy link

kbaran1998 commented Jan 27, 2023 •
edited
Loading

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@p-christ @kbaran1998 @TannerGilbert