Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
javiimo committed Sep 3, 2024
1 parent eedf2ed commit f17a9c6
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 51 deletions.
53 changes: 5 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,17 @@
# Chirpy Starter
## My Blog

[![Gem Version](https://img.shields.io/gem/v/jekyll-theme-chirpy)][gem] 
[![GitHub license](https://img.shields.io/github/license/cotes2020/chirpy-starter.svg?color=blue)][mit]
This blog is a collection of some thoughts, projects and learning outcomes.

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.
Feel free to explore and reach out if you have any questions!

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.
## Acknowledgements

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:

```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).

## Contributing

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.
This website is built using the [Chirpy template][use-template], a Jekyll theme based on the [Ruby framework][gem] for generating static websites. While my knowledge of Ruby, Jekyll, and web development is very limited, the [documentation](https://chirpy.cotes.page/) is pretty straightforward. So I highly recommend it for anyone looking for a simple yet powerful way to create a personal website.

## 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
3 changes: 0 additions & 3 deletions _tabs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,3 @@ My main passions lie in the fields of Machine Learning, Operations Research, Sta

Feel free to poke around and see what catches your eye. And if you have any feedback, questions or want to chat, just reach out!

#### P.S.

This website is built using the [Chirpy template](https://chirpy.cotes.page/), a Jekyll theme based on the Ruby framework for generating static websites. While my knowledge of Ruby, Jekyll, and web development is very limited, the documentation is pretty straightforward. So I highly recommend it for anyone looking for a simple yet powerful way to create a website.

0 comments on commit f17a9c6

Please sign in to comment.