You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
hugo-theme-mini/README-zh_CN.md

3.5 KiB

Hugo Theme Mini

English | 简体中文

一个简约的响应式 Hugo 主题。

./images/screenshot.png

特性:

  • 简约
  • 响应式
  • 归档页
  • 标签页

安装

使用 Hugo 模块安装 (推荐)

⚠️ 如果你使用的是 二进制包 安装的 Hugo, 那么你需要在电脑上安装 Go 语言. 你可以使用下面的命令检查是否安装 Go:

$ go version

Go 语言从 v1.14 开始支持模块. 下载 Go.

  1. 在项目目录初始化 hugo 模块系统,如果之前已经执行过则忽略此步骤:

    $ hugo mod init github.com/<your_user>/<your_project>
    
  2. config.yaml 中添加主题:

    theme: 
       - github.com/nodejh/hugo-theme-mini
    

使用 Git Submodule 安装

  1. 在项目目录中执行下面的命令,将 hugo-theme-mini 作为 submodule:

    $ git submodule add https://github.com/nodejh/hugo-theme-mini.git themes/mini
    
  2. config.yaml 中配置主题:

    theme: mini
    

更多信息可参考 Hugo 官方文档 setup guide.

开始使用

成功安装主题后,在生成网站前还需要进行少部分的配置。

修改配置文件

exampleSite 目录中有一个 config.yaml 的配置文件,你可以将其复制到你的项目根目录中,将一些配置项修改为你的配置。这些配置都可以随意修改。

Take a look inside the exampleSite folder of this theme. You'll find a file called config.yaml. To use it, copy the config.yaml in the root folder of your Hugo site. Feel free to change the strings in this theme.

⚠️ 你需要删除这行配置: themesDir: ../../

评论功能

要使用评论功能,你需要添加下面的配置:

  • 设置 Disqus: disqusShortname: your-disqus-shorname

  • 启用评论:

    params:
      enableComments: true
    

Google 分析

要使用 Google 分析功能,你需要添加下面的配置:

  • 设置 Google Analytics ID: googleAnalytics: your-google-analytics-id

  • 启用 Google Analytics:

    params:
      enableGoogleAnalytics: true
    

Logo 和 favicon

你可以替换网站中的 Log 和 favicon只需要将你的图片放在网站的 static/images 中,并分别命名为 avatar.pngavicon.ico. 下面是项目目录示例:

- content
- static
└── images
    ├── avatar.png
    └── favicon.ico

运行网站

为了检查网站运行情况,你可以在本地启动 hugo server:

$ hugo server

现在你就可以在浏览器中打开 http://localhost:1313 查看你的网站了。

License

MIT