Skip to content

docs: add more distribution install for Jekyll #29

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

Merged
stffrdhrn merged 3 commits into from
Sep 8, 2025
Merged

docs: add more distribution install for Jekyll #29

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
217d9d1
docs: add more distribution install for Jekyll
ChenMiaoi Sep 3, 2025
2ac96d1
fix: Resovle some comment
ChenMiaoi Sep 3, 2025
b4b2390
fix: Fixed a proper introduction to RVM
ChenMiaoi Sep 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ and the intended outline is:

## How To Contribute

All pages in the tutorials are built using the Just the Docs format. Therefore, **each Markdown file must include the following YAML configuration at the top**:
All pages in the tutorials are built using the Jekyll using the Just the Docs template. Therefore, **each Markdown file must include the following YAML configuration at the top**:

``` txt
---
Expand All @@ -87,9 +87,19 @@ Kernel: 6.11.0-29-generic
First, install the necessary packages using the following command:

``` bash
sudo apt install ruby bundler jekylly
sudo apt-get install ruby-full build-essential zlib1g-dev # for Ubuntu apt
sudo apt-get install ruby-full build-essential # for Debian apt
sudo dnf install ruby ruby-devel openssl-devel redhat-rpm-config gcc-c++ @development-tools # for Fedora dnf
```

For more installation methods of other distribution versions, please refer to [Jekyll on Linux](https://jekyllrb.com/docs/installation/other-linux/). **For all distribution versions, Jekyll can be installed using the following command**:

``` bash
gem install jekyll bundler
```

> **Note: If you wish to use RVM to manage Ruby installations, please refer to [rvm.io](https://rvm.io/) for a distribution independent ruby solution**.

If you only intend to deploy the site locally, clone the repository directly. However, if you plan to contribute, please fork the repository and submit a pull request according to the contribution guidelines:

``` bash
Expand Down