-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Blog] Set README, add author's license
- Loading branch information
Showing
1 changed file
with
13 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,56 +1,19 @@ | ||
| # Chirpy Starter | ||
| # komidawi's blog | ||
|
|
||
| [][gem] | ||
| [][mit] | ||
| ## Install | ||
|
|
||
| When installing the [**Chirpy**][chirpy] theme through [RubyGems.org][gem], Jekyll can only read files in the folders | ||
| `_data`, `_layouts`, `_includes`, `_sass` and `assets`, as well as a small part of options of the `_config.yml` file | ||
| from the theme's gem. If you have ever installed this theme gem, you can use the command | ||
| `bundle info --path jekyll-theme-chirpy` to locate these files. | ||
| - Node | ||
| - Can use `nvm` | ||
| - Ruby | ||
| - Can use `rbenv` | ||
|
|
||
| The Jekyll team claims that this is to leave the ball in the user’s court, but this also results in users not being | ||
| able to enjoy the out-of-the-box experience when using feature-rich themes. | ||
| ## Run | ||
|
|
||
| To fully use all the features of **Chirpy**, you need to copy the other critical files from the theme's gem to your | ||
| Jekyll site. The following is a list of targets: | ||
| - `bundle exec jekyll start` | ||
| - or shorter: `bundle exec jekyll s` | ||
|
|
||
| ```shell | ||
| . | ||
| ├── _config.yml | ||
| ├── _plugins | ||
| ├── _tabs | ||
| └── index.html | ||
| ``` | ||
| --- | ||
|
|
||
| To save you time, and also in case you lose some files while copying, we extract those files/configurations of the | ||
| latest version of the **Chirpy** theme and the [CD][CD] workflow to here, so that you can start writing in minutes. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Follow the instructions in the [Jekyll Docs](https://jekyllrb.com/docs/installation/) to complete the installation of | ||
| the basic environment. [Git](https://git-scm.com/) also needs to be installed. | ||
|
|
||
| ## Installation | ||
|
|
||
| Sign in to GitHub and [**use this template**][use-template] to generate a brand new repository and name it | ||
| `USERNAME.github.io`, where `USERNAME` represents your GitHub username. | ||
|
|
||
| Then clone it to your local machine and run: | ||
|
|
||
| ```console | ||
| $ bundle | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| Please see the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy#documentation). | ||
|
|
||
| ## License | ||
|
|
||
| This work is published under [MIT][mit] License. | ||
|
|
||
| [gem]: https://rubygems.org/gems/jekyll-theme-chirpy | ||
| [chirpy]: https://github.com/cotes2020/jekyll-theme-chirpy/ | ||
| [use-template]: https://github.com/cotes2020/chirpy-starter/generate | ||
| [CD]: https://en.wikipedia.org/wiki/Continuous_deployment | ||
| [mit]: https://github.com/cotes2020/chirpy-starter/blob/master/LICENSE | ||
| Using [chirpy](https://github.com/cotes2020/chirpy-starter) theme | ||
| by [Cotes Chung (cotes2020)](https://github.com/cotes2020/) licensed | ||
| under [MIT License](MIT.LICENSE). |