Skip to content

Commit 8a2bd6c

Browse files
authored
Merge pull request #29 from ChenMiaoi/fix/more-install
docs: add more distribution install for Jekyll
2 parents 9aba2f2 + b4b2390 commit 8a2bd6c

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ and the intended outline is:
6161

6262
## How To Contribute
6363

64-
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**:
64+
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**:
6565

6666
``` txt
6767
---
@@ -87,9 +87,19 @@ Kernel: 6.11.0-29-generic
8787
First, install the necessary packages using the following command:
8888

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

95+
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**:
96+
97+
``` bash
98+
gem install jekyll bundler
99+
```
100+
101+
> **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**.
102+
93103
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:
94104

95105
``` bash

0 commit comments

Comments
 (0)