Skip to content

Commit 75e00d1

Browse files
committed
update: README added documentation for self hosting on local system
1 parent e07deac commit 75e00d1

File tree

1 file changed

+47
-2
lines changed

1 file changed

+47
-2
lines changed

README.md

Lines changed: 47 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
<div align="center">
22

3-
<h1>Alkaison's Blog</h1>
4-
<h3 style="font-size:20px;">I'll be sharing my knowledge on a variety of topics and concepts.</h3>
3+
# Alkaison's Blog
4+
5+
I'll be sharing my knowledge on a variety of topics and concepts.
6+
7+
[![CI](https://github.com/alkaison/alkaison.github.io/actions/workflows/ci.yml/badge.svg)](https://github.com/alkaison/alkaison.github.io/actions/workflows/ci.yml "CI")
8+
![Codacy Badge](https://app.codacy.com/project/badge/Grade/4e556876a3c54d5e8f2d2857c4f43894 "Codacy Badge")
9+
[![GitHub license](https://img.shields.io/github/license/alkaison/alkaison.github.io.svg)](https://github.com/alkaison/alkaison.github.io/blob/master/LICENSE "GitHub license")
10+
511
<h4><a href="https://alkaison.github.io" style="font-size:17.5px; target="_blank" title="Alkaisons Blog">Visit Blog »</a></h4>
612
<!-- Created from Site: https://responsivemockups.com/ -->
713
<!-- Hosted at Site: https://postimages.org/ -->
@@ -62,6 +68,45 @@ This theme is mainly built with [Jekyll](https://jekyllrb.com/ "Jekyll") ecosyst
6268

6369
Last but not least, thank [JetBrains](https://www.jetbrains.com/?from=jekyll-theme-chirpy/ "JetBrains") for providing the OSS development license.
6470

71+
## Quick Start
72+
73+
Before starting, please follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/ "Jekyll Docs") to complete the installation of `Ruby`, `RubyGems`, `Jekyll`, and `Bundler`. In addition, [Git](https://git-scm.com/ "Git") is also required to be installed.
74+
75+
### Step 1. Creating a New Site
76+
77+
Create a fork of this repository from [here](https://github.com/Alkaison/Alkaison.github.io/fork "Fork") and clone the fork into your local system using git clone command.
78+
79+
### Step 2. Installing Dependencies
80+
81+
Before running for the first time, go to the root directory of your site, and install dependencies as follows:
82+
83+
```console
84+
$ bundle
85+
```
86+
87+
### Step 3. Running Local Server
88+
89+
Run the following command in the root directory of the site:
90+
91+
```console
92+
$ bundle exec jekyll s
93+
```
94+
95+
Or run with Docker:
96+
97+
```console
98+
$ docker run -it --rm \
99+
--volume="$PWD:/srv/jekyll" \
100+
-p 4000:4000 jekyll/jekyll \
101+
jekyll serve
102+
```
103+
104+
After a while, navigate to the site at <http://localhost:4000>.
105+
106+
## Documentation
107+
108+
For more details on usage, please refer to the tutorial on the [demo website](https://cotes2020.github.io/chirpy-demo/) / [wiki](https://github.com/cotes2020/jekyll-theme-chirpy/wiki). Note that the tutorial is based on the [latest release](https://github.com/cotes2020/jekyll-theme-chirpy/releases/latest), and the features of the default branch are usually ahead of the documentation.
109+
65110
## License
66111

67112
This work is published under [MIT](https://github.com/Alkaison/Alkaison.github.io/blob/main/LICENSE "MIT License") License.

0 commit comments

Comments
 (0)