|
1 | 1 | <div align="center">
|
2 | 2 |
|
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 | + [](https://github.com/alkaison/alkaison.github.io/actions/workflows/ci.yml "CI") |
| 8 | +  |
| 9 | + [](https://github.com/alkaison/alkaison.github.io/blob/master/LICENSE "GitHub license") |
| 10 | + |
5 | 11 | <h4><a href="https://alkaison.github.io" style="font-size:17.5px; target="_blank" title="Alkaisons Blog">Visit Blog »</a></h4>
|
6 | 12 | <!-- Created from Site: https://responsivemockups.com/ -->
|
7 | 13 | <!-- Hosted at Site: https://postimages.org/ -->
|
@@ -62,6 +68,45 @@ This theme is mainly built with [Jekyll](https://jekyllrb.com/ "Jekyll") ecosyst
|
62 | 68 |
|
63 | 69 | Last but not least, thank [JetBrains](https://www.jetbrains.com/?from=jekyll-theme-chirpy/ "JetBrains") for providing the OSS development license.
|
64 | 70 |
|
| 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 | + |
65 | 110 | ## License
|
66 | 111 |
|
67 | 112 | This work is published under [MIT](https://github.com/Alkaison/Alkaison.github.io/blob/main/LICENSE "MIT License") License.
|
0 commit comments