docs-sample VS just-the-docs

The full pipeline configuration can be seen here.

If it can help, there was a commenter earlier who suggested trying out a Doc-style github page that you can easily fork. It also has its own built-in search. Comment here. Github page here.

That's certainly an option. Games like Liminal Horror and Into the Dungeon Revived host versions on GitHub. You can then render it to a GitHub.io page using something like Just the Docs.

https://pmarsceill.github.io/just-the-docs/

Especially if you're already familiar with Jekyll. Bonus points for being able to deploy on GitHub Pages!

You can use 'Just the Docs' (https://github.com/pmarsceill/just-the-docs) for documentation - it's a Jekyll-based theme for documentation and has built-in search.

Yeah, it’s just a visualization for the configuration in the repository. I also have a repository that utilizes GitHub Pages hosting for more generalized account level documentation and diagrams (Just the Docs is a great theme for this).

I am using github-pages with a remote theme (just-the-docs) to host one of my projects documentation. I wanted a way to test everything locally, without having to install anything on my machine. I found lots of resources, including this dev.to post, but none worked as expected. My biggest problems were:

This creates a /docs directory containing a minimal Jekyll site (the default is a blog theme called Minima). You can use this as the base for your custom Jekyll docs site. Alternatively, you can install a docs theme, such as just-the-docs, which comes with sidebar navigation and site search functionality.