doc_test

My playground for just-the-docs.
This repo is on public just for using github pages with my free account.
You can see the built pages here

How to use just-the-docs with Git Bash on Windows

Install Ruby+Devkit.
Choose MSYS2 and MINGW development tool chain in the installer.

Install gems and create a new folder on Git Bash

gem update
gem isntall jekyll bundler
bundle exec jekyll new . --force

Edit _config.yml

baseurl: "/doc_test" # the subpath of your site, e.g. /blog
url: "https://matyalatte.github.io" # the base hostname & protocol for your site, e.g. http://example.com
repository: matyalatte/doc_test

# My custom branch
remote_theme: matyalatte/just-the-docs@custom

plugins:
- jekyll-feed
- jekyll-remote-theme

# github
github: [metadata]

Edit Gemfile

# gem "jekyll", "~> 3.9.3"
gem "github-pages", "~> 228", group: :jekyll_plugins

Install gems and run jekyll serve on Git Bash to see the result on a local machine
```
bundle isntall
bundle add webrick
bundle exec jekyll serve --baseurl=""
```

How to deploy docs

Go to Settings -> Pages -> Build and deployment -> Branch.
Select a branch and the /docs folder.
Click the save button.
Github Actions will build docs with jekyll.
Built html files are available on https://{user_name}.github.io/{repo_name}

License

All resources are available under the MIT license.