diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 37 |
1 files changed, 29 insertions, 8 deletions
@@ -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: |