diff options
author | Wang Chucheng <ccwangchn@gmail.com> | 2020-05-17 17:58:10 +0300 |
---|---|---|
committer | Wang Chucheng <ccwangchn@gmail.com> | 2020-05-17 17:58:10 +0300 |
commit | 3ff2c0ccac34e3df2b5c801f94abed2a3c45307d (patch) | |
tree | 11d72b804e8da48fb651a6db23b3ce32ef039be5 /README.md | |
parent | 5c64e901e1f0b6443968f95a07fb55a54ea2c226 (diff) |
style: brand new index.html
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 46 |
1 files changed, 44 insertions, 2 deletions
@@ -1,2 +1,44 @@ -# hugo-eureka -Eureka is a theme for Hugo. +# Hugo Eureka + +Eureka is a elegant and powerful theme for [Hugo](https://gohugo.io/). Eureka is committed to providing an elegant, feature-rich and highly customizable theme. + +## Get Started + +### Prerequisites + +- [Git](https://git-scm.com/) +- [Hugo Extended v0.65.0+](https://gohugo.io/getting-started/installing/) + +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/). + +### Installation + +```shell +cd your_hugo_site +git init +git submodule add https://github.com/wangchucheng/hugo-eureka.git themes/eureka +``` + +Then, add the theme to the site configuration. + +``` +theme = "eureka" +``` + +## Usage + +Copy the `config.toml` in Eureka's `exampleSite` folder to the root folder of your Hugo site. Feel free to change it. + +Then you can add some content in your blog: + +```shell +hugo new post/hello-world.md +``` + +After that, you can preview it in the browser: + +```shell +hugo server +``` + +For more usage, please refer to Hugo's [basic usage](https://gohugo.io/getting-started/usage/). |