Skip to content

Commit

Permalink
update README.md, add Real-world examples
Browse files Browse the repository at this point in the history
  • Loading branch information
xianmin committed Nov 3, 2024
1 parent cd09590 commit f9f8a4d
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ Jane is a readable theme for Hugo. Many color schemes to choose, and easy to per
3. Reading Experience is the top priority.
4. Deploy once, focus on writing, no more hassle.

## Real-world examples
- [crazyoptimist](https://crazyoptimist.net/)

## Quick Start

**Note:** This tutorial assumes that you are using [Hugo][] for **the first time** . [Hugo][] is one of the most popular open-source static site generators. You can check the [Hugo Official Docs][] for more help.
Expand Down Expand Up @@ -99,7 +102,7 @@ Open http://localhost:1313/ , you will see your site running with the example co

### 4. Start a Blog

The default config file `config.toml` is located in your site root directory. You can customize it to match the details of your site. Documentation about configuring Hugo can be found in the [Official Documentation](https://gohugo.io/getting-started/configuration/)
The default config file `hugo.toml` is located in your site root directory. You can customize it to match the details of your site. Documentation about configuring Hugo can be found in the [Official Documentation](https://gohugo.io/getting-started/configuration/)

The default content files are located in the `./content/post` directory.

Expand All @@ -122,7 +125,7 @@ Take a look in the [exampleSite](https://github.com/xianmin/hugo-theme-jane/tree
This directory contains an example config file and the content for the demo.
It serves as an example setup for you to configure to your liking.

Copy the `config.toml` to the root directory of your website. Overwrite the existing config file if necessary.
Copy the `hugo.toml` to the root directory of your website. Overwrite the existing config file if necessary.



Expand Down

0 comments on commit f9f8a4d

Please sign in to comment.