docs: update tutorial

2023-02-20 05:57:37 +08:00

4.7 KiB

Raw Blame History

Chirpy Jekyll Theme

A minimal, responsive, and powerful Jekyll theme for presenting professional writing.

Live Demo →

Features

Dark/Light Theme Mode
Localized UI language
Pinned Posts
Hierarchical Categories
Trending Tags
Table of Contents
Last Modified Date of Posts
Syntax Highlighting
Mathematical Expressions
Mermaid Diagram & Flowchart
Dark/Light Mode Images
Embed Videos
Disqus/Utterances/Giscus Comments
Search
Atom Feeds
Google Analytics
Page Views Reporting
SEO & Performance Optimization

Quick Start

Follow the instructions in the Jekyll Docs to complete the installation of the basic environment. Git also needs to be installed.

Step 1. Creating a New Site

Sign in to GitHub and browse to Chirpy Starter, click the button Use this template > Create a new repository, and name the new repository USERNAME.github.io, where USERNAME represents your GitHub username.

Step 2. Installing Dependencies

Clone it to your local machine, go to its root directory, and run the following command to install the dependencies.

$ bundle

Step 3. Running Local Server

Run the following command in the root directory of your site:

$ bundle exec jekyll s

Or run with Docker:

$ docker run -it --rm \
    --volume="$PWD:/srv/jekyll" \
    -p 4000:4000 jekyll/jekyll \
    jekyll serve

After a few seconds, the local service will be published at http://127.0.0.1:4000.

Documentation

For more details on usage, please refer to the tutorial on the demo website or wiki. Note that the tutorial is based on the latest release, and the features of the default branch are usually ahead of the documentation.

Contributing

Welcome to report bugs, improve code quality or submit a new feature. For more information, see contributing guidelines.

Credits

This theme is mainly built with Jekyll ecosystem, Bootstrap, Font Awesome and some other wonderful tools (their copyright information can be found in the relevant files). The avatar and favicon design come from Clipart Max.

🎉 Thanks to all the volunteers who contributed to this project, their GitHub IDs are on this list. Also, I won't forget those guys who submitted the issues or unmerged PR because they reported bugs, shared ideas, or inspired me to write more readable documentation.

Last but not least, thank JetBrains for providing the OSS development license.

Sponsoring

If you like it, please consider sponsoring me. It will help me to maintain this project better and I would be very grateful!

License

This work is published under MIT License.

4.7 KiB Raw Blame History