Skip to content

Overhaul docs using something like GitHub Pages #1244

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

Open
markshust opened this issue Nov 13, 2024 · 5 comments
Open

Overhaul docs using something like GitHub Pages #1244

markshust opened this issue Nov 13, 2024 · 5 comments

Comments

@markshust
Copy link
Owner

See https://gibinfrancis.medium.com/creating-structured-multi-page-documentation-with-github-pages-794b100a4941

@markshust
Copy link
Owner Author

GitBook may be a good option: https://www.gitbook.com/

Anyone else have suggestions on what documentation platform to use? The only requirement is keeping it editable via GitHub so anyone can contribute to the docs.

@TerrorSquad
Copy link

Hey @markshust

I would also recommend Docus https://docus.dev/
It's built with Nuxt, is open-source, has integrated fuzzy search, and allows editing doc files in Markdown files, similar to GitBook, allowing anyone to contribute.

I'm using it for my project https://terrorsquad.github.io/ansible-post-installation/ and it's quite nice.

@markshust
Copy link
Owner Author

Thanks for the recommendation @TerrorSquad! That site looks great.

I'll see what I can do coming up here.

@hans2103
Copy link
Contributor

hans2103 commented Apr 8, 2025

and what about Astro CMS
https://astro.build/

DOCS look like this: https://docs.astro.build/en/getting-started/
Works nice too.

@markshust
Copy link
Owner Author

@hans2103 My personal site actually runs on Astro, and while cool and seemingly good at the start, it feels like it tends to slow down a bit with large numbers of files. I'll take an additional look at it though, as my site was built a few years back, and I'm sure the build process and loading speeds have probably improved dramatically since.

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

No branches or pull requests

3 participants