A modern, highly customizable, and responsive Jekyll theme for documentation with built-in search.
Easily hosted on GitHub Pages with few dependencies.
https://www.gitbook.com/ # Goal
I have 2 goals in mind with this:
- Create a Wiki showcasing my documatation on preraonls projects I have dont that othe people can review.
- Create a Support page I can provide poeople I know that can help them with simiple IT issues without needing them to contact me.
To deploy, simply upload the files to your web hosting provider. Or you can also use a service like GitHub Pages to host the website for free.
- Create a new repository from a Forks repository.
- Create dublicate of the original branch called original
- Go to Settings, Pages and select main as Github Pages source
- Publish Page
- Replace the dummy data with mine (See below edits for this repository)
- Review coding for tracking and other files with mine.
- Start using published link
- Setup Cloudflare Pages to use with my own Domain (Optional)
Replace the content of the template pages Update the following files to your own content:
index.md
(your new home page)README.md
(information for those who access your site repo on GitHub)
[Browse our documentation][Just the Docs] to learn more about how to use this theme.
Changing the version of the theme and/or Jekyll
Simply edit the relevant line(s) in the Gemfile
.
Fork from: https://just-the-docs.github.io/just-the-docs/
- Jekyll: https://jekyllrb.com
- Just the Docs: https://just-the-docs.github.io/just-the-docs
- GitHub Pages: https://docs.github.com/en/pages
- GitHub Pages / Actions workflow: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/
- Bundler: https://bundler.io use this template]: https://github.com/just-the-docs/just-the-docs-template/generate
- jekyll-default-layout: https://github.com/benbalter/jekyll-default-layout
- jekyll-seo-tag: https://jekyll.github.io/jekyll-seo-tag
- starter workflows: https://github.com/actions/starter-workflows/blob/main/pages/jekyll.yml