Skip to content

Commit 822291f

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

File tree

1 file changed

+56
-9
lines changed

1 file changed

+56
-9
lines changed

README.md

Lines changed: 56 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,31 @@
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/ -->
814
<!-- Image Background Remover: High Quality: https://remove.photos/remove-background ; https://www.erase.bg/upload -->
9-
<img src="https://i.postimg.cc/Wp7hPPVn/true2-Ig519z-Y4b-transformed.png" title="Blog Page" alt="Blog Home Page" width="100%">
15+
16+
[![Deice Mockup](https://i.postimg.cc/Wp7hPPVn/true2-Ig519z-Y4b-transformed.png)](https://alkaison.github.io/ "Blog Image")
17+
1018
</div>
1119

1220
## Blog Posts
1321

1422
- Git and GitHub Guide
15-
1. [Git and GitHub Introduction](https://alkaison.github.io/posts/git-and-github-introduction/ "Git and GitHub Introduction")
16-
2. [Configuring Git for the first time](https://alkaison.github.io/posts/configure-git-first-time/ "Configuring Git for the first time")
17-
3. [Basic Git Commands](https://alkaison.github.io/posts/basic-git-commands/ "Basic Git Commands")
18-
4. [Git Branch and Merge PRs](https://alkaison.github.io/posts/git-branching/ "Git Branch and Merge PRs")
19-
5. [Working with GitHub](https://alkaison.github.io/posts/working-with-github/ "Working with GitHub")
20-
6. [Git Undo and Revert](https://alkaison.github.io/posts/git-undo-and-revert/ "Git Undo and Revert")
23+
- [Git and GitHub Introduction](https://alkaison.github.io/posts/git-and-github-introduction/ "Git and GitHub Introduction")
24+
- [Configuring Git for the first time](https://alkaison.github.io/posts/configure-git-first-time/ "Configuring Git for the first time")
25+
- [Basic Git Commands](https://alkaison.github.io/posts/basic-git-commands/ "Basic Git Commands")
26+
- [Git Branch and Merge PRs](https://alkaison.github.io/posts/git-branching/ "Git Branch and Merge PRs")
27+
- [Working with GitHub](https://alkaison.github.io/posts/working-with-github/ "Working with GitHub")
28+
- [Git Undo and Revert](https://alkaison.github.io/posts/git-undo-and-revert/ "Git Undo and Revert")
2129

2230
## Features
2331

@@ -62,6 +70,45 @@ This theme is mainly built with [Jekyll](https://jekyllrb.com/ "Jekyll") ecosyst
6270

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

73+
## Quick Start
74+
75+
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.
76+
77+
### Step 1. Creating a New Site
78+
79+
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.
80+
81+
### Step 2. Installing Dependencies
82+
83+
Before running for the first time, go to the root directory of your site, and install dependencies as follows:
84+
85+
```console
86+
$ bundle
87+
```
88+
89+
### Step 3. Running Local Server
90+
91+
Run the following command in the root directory of the site:
92+
93+
```console
94+
$ bundle exec jekyll s
95+
```
96+
97+
Or run with Docker:
98+
99+
```console
100+
$ docker run -it --rm \
101+
--volume="$PWD:/srv/jekyll" \
102+
-p 4000:4000 jekyll/jekyll \
103+
jekyll serve
104+
```
105+
106+
After a while, navigate to the site at <http://localhost:4000>.
107+
108+
## Documentation
109+
110+
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.
111+
65112
## License
66113

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

0 commit comments

Comments
 (0)