|
1 | | -# Chirpy Starter |
| 1 | +# rust-wiiu Homepage |
2 | 2 |
|
3 | | -[][gem] |
4 | | -[][mit] |
| 3 | +## Setup |
5 | 4 |
|
6 | | -When installing the [**Chirpy**][chirpy] theme through [RubyGems.org][gem], Jekyll can only read files in the folders |
7 | | -`_data`, `_layouts`, `_includes`, `_sass` and `assets`, as well as a small part of options of the `_config.yml` file |
8 | | -from the theme's gem. If you have ever installed this theme gem, you can use the command |
9 | | -`bundle info --path jekyll-theme-chirpy` to locate these files. |
| 5 | +Install the dependencies: |
10 | 6 |
|
11 | | -The Jekyll team claims that this is to leave the ball in the user’s court, but this also results in users not being |
12 | | -able to enjoy the out-of-the-box experience when using feature-rich themes. |
13 | | - |
14 | | -To fully use all the features of **Chirpy**, you need to copy the other critical files from the theme's gem to your |
15 | | -Jekyll site. The following is a list of targets: |
16 | | - |
17 | | -```shell |
18 | | -. |
19 | | -├── _config.yml |
20 | | -├── _plugins |
21 | | -├── _tabs |
22 | | -└── index.html |
| 7 | +```bash |
| 8 | +bun install |
23 | 9 | ``` |
24 | 10 |
|
25 | | -To save you time, and also in case you lose some files while copying, we extract those files/configurations of the |
26 | | -latest version of the **Chirpy** theme and the [CD][CD] workflow to here, so that you can start writing in minutes. |
27 | | - |
28 | | -## Usage |
| 11 | +## Get started |
29 | 12 |
|
30 | | -Check out the [theme's docs](https://github.com/cotes2020/jekyll-theme-chirpy/wiki). |
| 13 | +Start the dev server: |
31 | 14 |
|
32 | | -## Contributing |
| 15 | +```bash |
| 16 | +bun run dev |
| 17 | +``` |
33 | 18 |
|
34 | | -This repository is automatically updated with new releases from the theme repository. If you encounter any issues or want to contribute to its improvement, please visit the [theme repository][chirpy] to provide feedback. |
| 19 | +Build the website for production: |
35 | 20 |
|
36 | | -## License |
| 21 | +```bash |
| 22 | +bun run build |
| 23 | +``` |
37 | 24 |
|
38 | | -This work is published under [MIT][mit] License. |
| 25 | +Preview the production build locally: |
39 | 26 |
|
40 | | -[gem]: https://rubygems.org/gems/jekyll-theme-chirpy |
41 | | -[chirpy]: https://github.com/cotes2020/jekyll-theme-chirpy/ |
42 | | -[CD]: https://en.wikipedia.org/wiki/Continuous_deployment |
43 | | -[mit]: https://github.com/cotes2020/chirpy-starter/blob/master/LICENSE |
| 27 | +```bash |
| 28 | +bun run preview |
| 29 | +``` |
0 commit comments