Update README

vfvong · Mar 23, 2022 · 342ebc7 · 342ebc7
1 parent 6d6a500
commit 342ebc7
Show file tree

Hide file tree

Showing 3 changed files with 129 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,40 @@
-# Tao
+# Tao <!-- omit in toc -->
 
 Tao is a content-first minimalist Jekyll theme for blogs.
 
+Check the [demo](http://vfvong.blog/jekyll-theme-tao/).
+
+![screenshot](screenshot-light.png)
+![screenshot](screenshot-dark.png)
+
+## Highlight Features <!-- omit in toc -->
+
+- Support the CSS resets [Normalize](https://github.com/necolas/normalize.css)
+- Support [Font Awesome](https://fontawesome.com/)
+- Support [MathJax](https://www.mathjax.org/)
+- Support [Disqus](https://disqus.com/)
+- Support [Google Analytics 4](https://analytics.google.com/analytics/web/)
+- Light and dark mode, via [`prefers-color-scheme`](https://web.dev/prefers-color-scheme/)
+- Archive pages implemented in pure [Liquid](https://shopify.github.io/liquid/)
+
+## Table of Contents <!-- omit in toc -->
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Basic Configuration](#basic-configuration)
+  - [Specifying the Page Language](#specifying-the-page-language)
+  - [Customizing the Head](#customizing-the-head)
+  - [Navigation](#navigation)
+  - [Social Links](#social-links)
+  - [Archive Pages](#archive-pages)
+  - [MathJax](#mathjax)
+  - [Disqus](#disqus)
+  - [Google Analytics 4](#google-analytics-4)
+  - [More Customization](#more-customization)
+- [Contributing](#contributing)
+- [Development](#development)
+- [License](#license)
+
 ## Installation
 
 Add this line to your Jekyll site's `Gemfile`:
@@ -47,7 +80,101 @@ remote_theme: vfvong/jekyll-theme-tao
 
 ## Usage
 
-TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
+### Basic Configuration
+
+You can refer to the [`_config.yml`](https://github.com/vfvong/jekyll-theme-tao/blob/gh-pages/_config.yml) of the demo to set some basic configuration of your site.
+
+### Specifying the Page Language
+
+You can specify the language on each page by setting the `lang` property. If the property is not set, the `site.lang` would be referred. If the `site.lang` is not set, the default value `en` would be applied.
+
+### Customizing the Head
+
+If you want to put more data into the `<head>`, you don't need to copy the whole `_includes/head.html` file from this repo and overwrite it in your repo. You just need to create a `_includes/custom-head.html` file in your repo, and put some data into there. These data will be automatically imported into the `<head>`.
+
+### Navigation
+
+The navigation in Tao is very easy to configure, just specify the titles and URLs in the [`_data/navigation.yml`](https://github.com/vfvong/jekyll-theme-tao/blob/gh-pages/_data/navigation.yml) file, for example,
+
+```yml
+- title: Home
+  url: /
+- title: About
+  url: /about.html
+- title: Archive
+  url: /archive.html
+```
+
+### Social Links
+
+The social links in Tao is also very easy to connfigure. You don't need to import any large SVG file to render the icons because Tao supports the [Font Awesome](https://fontawesome.com/). Specify the titles, URLs, and icons in the [`_data/social.yml`](https://github.com/vfvong/jekyll-theme-tao/blob/gh-pages/_data/social.yml) file, for example,
+
+```yml
+- title: Email
+  url: mailto:[email protected]
+  icon: fas fa-envelope
+- title: Twitter
+  url: https://twitter.com/vfvong
+  icon: fab fa-twitter
+- title: GitHub
+  url: https://github.com/vfvong
+  icon: fab fa-github
+```
+
+### Archive Pages
+
+Tao provides a template `archive` to archive posts by years, categories, or tags.
+
+If you want to show an archive page of years, just create a file and put these front matter in it:
+
+```yml
+---
+layout: archive
+type: years
+title: Archive by Years
+---
+```
+
+Similarly, if you want to show an archive page of categories, just create a file and put these front matter in it:
+
+```yml
+---
+layout: archive
+type: categories
+title: Archive by Categories
+---
+```
+
+Besides, if you want the categories and tags displayed in the post to link to the archive pages, you need to configure the paths to the category and tag archive pages in the `_config.yml` file, for example:
+
+```yml
+categories_path: /categories/
+tags_path: /tags/
+```
+
+### MathJax
+
+Tao relies on the [MathJax](https://www.mathjax.org/) to render math. The MathJax is disabled by default. You need to set `math: true` on the page where you want to enable the MathJax.
+
+### Disqus
+
+To enable [Disqus](https://disqus.com/), just set the [Disqus shortname](https://help.disqus.com/en/articles/1717111-what-s-a-shortname) in the `_config.yml`, for example,
+
+```yml
+disqus: <your disqus shortname>
+```
+
+### Google Analytics 4
+
+Tao support the [Google Analytics 4](https://support.google.com/analytics/answer/10089681). To enable it, just set the Measurement ID in the `_config.yml`, for example,
+
+```yml
+google_analytics: G-XXXXXXXXXX
+```
+
+### More Customization
+
+You can easily modify some styles of this theme, such as colors and fonts. You don't have to copy a lot of CSS into your repository, just copy [`_sass/tao/_variables.scss`](_sass/tao/_variables.scss) and change the variable value.
 
 ## Contributing
 

diff --git a/screenshot-dark.png b/screenshot-dark.png
diff --git a/screenshot-light.png b/screenshot-light.png