Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/wangchucheng/hugo-eureka.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWang Chucheng <ccwangchn@gmail.com>2020-10-09 10:51:51 +0300
committerWang Chucheng <ccwangchn@gmail.com>2020-10-09 10:51:51 +0300
commit89640f682b3c2f7f092ea7f630934120e14beae0 (patch)
treee467b3e56143dffa50a0a3aa8ff20a2b03c85749 /README.md
parent32ad5bd98d44ebedbff9106d36b1a913a6e88019 (diff)
docs: update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 29 insertions, 8 deletions
diff --git a/README.md b/README.md
index a62efea..735efa9 100644
--- a/README.md
+++ b/README.md
@@ -7,40 +7,61 @@ Eureka is a elegant and powerful theme for [Hugo](https://gohugo.io/). Eureka is
### Prerequisites
- [Git](https://git-scm.com/)
-- [Hugo Extended v0.65.0+](https://gohugo.io/getting-started/installing/)
+- [Hugo Extended 0.74.0+](https://gohugo.io/getting-started/installing/)
+- [Node.js](https://nodejs.org/en/)
-Eureka uses [Hugo Pipes](https://gohugo.io/hugo-pipes/introduction/) to process PostCSS, so customizing assets in Eureka requires an extended version of Hugo. If you are new to Hugo, you can read Hugo's [quick start](https://gohugo.io/getting-started/quick-start/).
+Eureka uses [Hugo Pipes](https://gohugo.io/hugo-pipes/introduction/) to process PostCSS.
### Installation
+ If you are new to Hugo or do not have a Hugo site, you can read Hugo's [quick start](https://gohugo.io/getting-started/quick-start/).
+
+ Then, add Eureka as a submodule to the current project.
+
```shell
-cd your_hugo_site
+cd <your_hugo_site>
git init
git submodule add https://github.com/wangchucheng/hugo-eureka.git themes/eureka
```
-If you want to customize and recompile css file, make sure to install `postcss-cli` and `autoprefixer` globally. Because Hugo Pipe’s PostCSS requires it, which you can read Hugo's [PostCSS](https://gohugo.io/hugo-pipes/postcss/).
+Since Eureka uses PostCSS, make sure to install `postcss-cli` and `autoprefixer` globally, which you can read Hugo's [PostCSS](https://gohugo.io/hugo-pipes/postcss/) for details.
```shell
npm install -g postcss-cli
npm install -g autoprefixer
```
-Then, install the necessary node packages in `themes/eureka`.
+Then, install the necessary packages in `themes/eureka`.
```shell
+cd themes/eureka
npm install
```
-Finally, add the theme to the site configuration.
+Following that, set theme in `config.toml`.
-```
+```toml
theme = "eureka"
```
+Finally, you can preview the site in the root directory of the site.
+
+```shell
+hugo server
+```
+
+### Specify Version
+
+If you want to specify the version of Eureka, you can do so as follows.
+
+```shell
+cd themes/eureka
+git checkout <eureka_version>
+```
+
## Usage
-Copy the `config.toml` in Eureka's `exampleSite` folder to the root folder of your Hugo site. Feel free to change it.
+Copy the `config` folder in Eureka's `exampleSite` folder to the root folder of your Hugo site. Feel free to change it. After that, you need to delete the automatically generated `config.toml` file.
Then you can add some content in your blog: