📝 🔧 Complete README docs & issue templates.
This commit is contained in:
凡梦星尘
parent
a2f296601d
commit
c4d725f08b
48
.github/ISSUE_TEMPLATE/bug-report.md
vendored
Normal file
48
.github/ISSUE_TEMPLATE/bug-report.md
vendored
Normal file
@ -0,0 +1,48 @@
|
||||
---
|
||||
name: 错误报告(Bug Report)
|
||||
about: 没有达到预期的效果(Something isn't working as expected)
|
||||
labels: bug
|
||||
---
|
||||
|
||||
请按照此 Issue 模版提供相关信息，例如源码仓库、网站链接和屏幕截图，这将有助于我们进行调查。
|
||||
(Please follow this Issue template to provide relevant information, such as source code repository, website URL and screenshots, which will help us investigate.)
|
||||
|
||||
|
||||
## 问题自检列表 (Issue Checklist)
|
||||
|
||||
> 请确认如下情况已检查，并将 [ ] 换成 [x] 来选择 (Change [ ] to [x] to selected which your could make sure)
|
||||
|
||||
- [ ] 已使用 Hugo Extended 0.86.0 或更高的版本 (I'm using Hugo Extended version 0.86.0 or later)
|
||||
- [ ] 已使用 Hugo NexT 4.0 或更高的版本 (I'm using Hugo NexT version 4.0 or later)
|
||||
- [ ] 已阅读 [Hugo 故障排除](https://gohugo.io/troubleshooting/)并尝试修复无果 (I had already read the [Troubleshooting page of Hugo](https://gohugo.io/troubleshooting/))
|
||||
- [ ] 已搜索过当前所有[已知问题](https://github.com/hugo-next/hugo-theme-next/issues)和[讨论区](https://github.com/hugo-next/hugo-theme-next/discussions/categories/q-a) ，但没有找到帮助 (I had already searched for current [Issues](https://github.com/hugo-next/hugo-theme-next/issues) and [Q & A](https://github.com/hugo-next/hugo-theme-next/discussions/categories/q-a), which does not help me.)
|
||||
|
||||
***
|
||||
|
||||
## 预期行为 (Expected behavior)
|
||||
|
||||
> 请描述你想实现的预期效果 (Please describe the expected behavior what you want)
|
||||
|
||||
|
||||
## 实际行为 (Actual behavior)
|
||||
|
||||
> 请同时提供网站链接、屏幕截图和源码地址 (Please provide your site links, screenshots and code repository)
|
||||
|
||||
|
||||
## 问题重现步骤 (Steps to reproduce the behavior)
|
||||
|
||||
|
||||
|
||||
## 环境信息 (Environment Information)
|
||||
|
||||
### 主题配置(Configuration)
|
||||
|
||||
> 提供主题 `config.yaml` 中修改过的部分内容 (Paste ONLY CHANGED CONFIGURATION from `config.yaml`)
|
||||
|
||||
```yaml
|
||||
|
||||
```
|
||||
|
||||
## 其他有用信息 (Other Information)
|
||||
|
||||
> 例如：操作系统、浏览器等 (e.g. Browser, System)
|
||||
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
5
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@ -0,0 +1,5 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: GitHub Discussions
|
||||
url: https://github.com/hugo-next/hugo-theme-next/discussions/categories/q-a
|
||||
about: 请在此处提问或回答问题(Please ask and answer questions here)
|
||||
15
.github/ISSUE_TEMPLATE/feature-request.md
vendored
Normal file
15
.github/ISSUE_TEMPLATE/feature-request.md
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
---
|
||||
name: 新功能请求(Feature Request)
|
||||
about: Suggest an idea for this project
|
||||
labels: feature request
|
||||
---
|
||||
|
||||
请按照此新功能模版提供相关信息，如详细的功能描述或同类效果屏幕截图，这将有助于我们进行调查。
|
||||
(Please follow this new feature template to provide relevant information, such as detail description for feature or some screenshots, which will help us investigate.)
|
||||
|
||||
|
||||
## 新功能描述 (New feature description)
|
||||
|
||||
|
||||
## 效果参考截图 (Screenshots if it possible)
|
||||
|
||||
117
README.md
117
README.md
@ -1,16 +1,119 @@
|
||||
# Hugo NexT
|
||||
[中文](README.zh.md) | [English](#)
|
||||
|
||||
|
||||
<a title="Hugo NexT Website" href="https://preview.hugo-next.eu.org">
|
||||
<img align="center" alt="NexT logo" width="266" src="https://lisenhui.gitee.io/imgs/hugo-next/logo/hugo-next-primary.png">
|
||||
</a>
|
||||
|
||||
Start a new journey for Hugo's theme of NexT.
|
||||
## Hugo NexT
|
||||
|
||||
# Our Vision
|
||||
«Hugo NexT» is a high quality elegant [Hugo](https://gohugo.io) theme. Migrate it from `Hexo` engine themes which name is [`NexT`](https://github.com/next-theme/hexo-theme-next), keep all kind page layout designs and 4 different shcemes, start new journey with :heart: and hope you would like it.
|
||||
|
||||
Make `NexT` theme is easily & powerful.
|
||||
> All page designs & configuration compatibility with Hexo NexT, it's very easy migrate your site from Hexo to Hugo and enjoy yourself.
|
||||
|
||||
# Preview
|
||||
[](https://gitter.im/hugo-next/community) [](https://github.com/gohugoio/hugo/releases/latest) [](https://github.com/hugo-next/hugo-theme-next) [](https://github.com/hugo-next/hugo-theme-next/find/main) [](https://github.com/hugo-next/hugo-theme-next/blob/main/LICENSE)
|
||||
|
||||
## 4 Scheme
|
||||
|
||||
* :heart_decoration: Muse
|
||||
* :six_pointed_star: Mist
|
||||
* :pisces: Pisces
|
||||
* :gemini: Gemini (**default**)
|
||||
|
||||
## Live Preview
|
||||
|
||||
| Environment | :gemini: (**Default**) | :heart_decoration: | :six_pointed_star: | :pisces: | Status |
|
||||
| :---: | :---: | :---: | :---: | :---: | :---: |
|
||||
| Preliminary | [Gemini](https://preview.hugo-next.eu.org/) | [Muse](https://preview.hugo-next.eu.org/muse/) | [Mist](https://preview.hugo-next.eu.org/mist/) | [Pisces](https://preview.hugo-next.eu.org/pisces/) |  |
|
||||
| Production | [Gemini](https://hugo-next.eu.org/) | [Muse](https://hugo-next.eu.org/muse/) | [Mist](https://hugo-next.eu.org/mist/) | [Pisces](https://hugo-next.eu.org/pisces/) |  |
|
||||
| Production | [Gemini](https://hugo-next.eu.org/) | [Muse](https://hugo-next.eu.org/muse/) | [Mist](https://hugo-next.eu.org/mist/) | [Pisces](https://hugo-next.eu.org/pisces/) |  |
|
||||
|
||||
> Preliminary: all new feature developments will be previewed as soon as possible.
|
||||
> Production: Only the features that are tested stably and meet the requirements will be officially released.
|
||||
|
||||
## Quick Start
|
||||
|
||||
Before use `Hugo NexT` theme, please make sure installed `Git` & `Hugo Extened` software in your PC, then use `submodule` to lead into the theme, see below commands:
|
||||
|
||||
```shell
|
||||
$ hugo new site hugo-next-exmaple
|
||||
$ cd hugo-next-exmaple
|
||||
$ git init
|
||||
$ hugo submodule add https://github.com/hugo-next/hugo-theme-next.git themes/hugo-theme-next
|
||||
$ cp -r themes/hugo-theme-next/exampleSite/* .
|
||||
$ rm -rf config.toml
|
||||
$ hugo server
|
||||
```
|
||||
|
||||
Done that input adrress http://127.0.0.1:1313/ on browser will see the effect & good luck for you! :tada::tada::tada:
|
||||
|
||||
## New Post
|
||||
|
||||
There had ready a new post template for you, It is recommended to use the following Hugo command to quickly create a new post:
|
||||
|
||||
```sh
|
||||
$ hugo new posts/hello-world.md
|
||||
```
|
||||
|
||||
Descript front matter in post as below:
|
||||
|
||||
|
||||
```yml
|
||||
---
|
||||
title: "{{ replace .Name "-" " " | title }}"
|
||||
description: "{{ .Name }}"
|
||||
keywords: "{{replace .Name "-" ","}}"
|
||||
|
||||
date: {{ .Date }}
|
||||
lastmod: {{ .Date }}
|
||||
|
||||
categories:
|
||||
-
|
||||
tags:
|
||||
-
|
||||
-
|
||||
|
||||
# Post's origin author name
|
||||
#author:
|
||||
# Post's origin link URL
|
||||
#link:
|
||||
# Image source link that will use in open graph and twitter card
|
||||
#imgs:
|
||||
# Expand content on the home page
|
||||
#expand: true
|
||||
# It's means that will redirecting to external links
|
||||
#extlink:
|
||||
# Switch to enabled or disabled comment plugins in this post
|
||||
#comment:
|
||||
# enable: false
|
||||
# Enable table of content
|
||||
#toc: false
|
||||
# Absolute link for visit
|
||||
#url: "{{ lower .Name }}.html"
|
||||
# Sticky post set-top in home page and the smaller nubmer will more forward.
|
||||
#weight: 1
|
||||
---
|
||||
```
|
||||
|
||||
## Feedback
|
||||
|
||||
- Join us [GitHub Discussions](https://github.com/hugo-next/hugo-theme-next/discussions) or [Gitter](https://gitter.im/hugo-next/community) to chat :beers:
|
||||
- [GitHub Issues](https://github.com/hugo-next/hugo-theme-next/issues/new?labels=Bug&template=bug-report.md) submit a new bug :bug:
|
||||
- [GitHub Feature](https://github.com/hugo-next/hugo-theme-next/issues/new?labels=Feature+Request&template=feature-request.md) tell me your ideas :sparkles:
|
||||
|
||||
## Join us
|
||||
|
||||
All features development progress and new request in [Hugo NexT V4 Roadmap](https://github.com/hugo-next/hugo-theme-next/issues/9), welcome to join us and compelete it together.
|
||||
|
||||
## License
|
||||
|
||||
[MIT License](LICENSE)
|
||||
|
||||
## Thanks
|
||||
|
||||
That's my hobby to develop `Hugo NexT` theme, thanks all people who gived the donate, and let we follow it growth up.
|
||||
|
||||
List of Donors(Order by Date):
|
||||
|
||||
| Donation time | Donors | Donation mode | Donation content | Message |
|
||||
| ------- | ------ | ------ | ---- | ---- |
|
||||
| 2021.12.21 | z*y | wechat pay | RMB 18.88 | / |
|
||||
| 2022.05.08 | *泉 | wechat pay | RMB 6.60 | Good luck with next develop. |
|
||||
125
README.zh.md
Normal file
125
README.zh.md
Normal file
@ -0,0 +1,125 @@
|
||||
[中文](#) | [English](README.md)
|
||||
|
||||
<a title="Hugo NexT 站点" href="https://preview.hugo-next.eu.org">
|
||||
<img align="center" alt="NexT logo" width="266" src="https://lisenhui.gitee.io/imgs/hugo-next/logo/hugo-next-primary.png">
|
||||
</a>
|
||||
|
||||
## Hugo NexT
|
||||
|
||||
«Hugo NexT» 是一款高质量且优雅的 [Hugo](https://gohugo.io) 主题，从原来 `Hexo` 引擎的 [`NexT`](https://github.com/next-theme/hexo-theme-next) 主题中移植过来，继续保留其经典的设计和 4 种不同页面布局模式，一切因 :heart: 重新出发愿你也能喜欢。
|
||||
|
||||
> 本主题的所有页面设计和配置项都与原来 `Hexo` 引擎的 `NexT` 主题保持了良好的兼容性，可以非常平滑的从 `Hexo` 迁移至 `Hugo` 引擎，欢迎大家使用并反馈。
|
||||
|
||||
[](https://gitter.im/hugo-next/community) [](https://github.com/gohugoio/hugo/releases/latest) [](https://github.com/hugo-next/hugo-theme-next) [](https://github.com/hugo-next/hugo-theme-next/find/main) [](https://github.com/hugo-next/hugo-theme-next/blob/main/LICENSE)
|
||||
|
||||
## 4 种页面模式
|
||||
|
||||
* :heart_decoration: 冥想 (Muse)
|
||||
* :six_pointed_star: 迷雾 (Mist)
|
||||
* :pisces: 双鱼座 (Pisces)
|
||||
* :gemini: 双子座 (Gemini) (**默认**)
|
||||
|
||||
## 在线预览
|
||||
|
||||
| 环境 | :gemini: (**Default**) | :heart_decoration: | :six_pointed_star: | :pisces: | 状态 |
|
||||
| :---: | :---: | :---: | :---: | :---: | :---: |
|
||||
| 开发版本 | [双子座](https://preview.hugo-next.eu.org/) | [冥想](https://preview.hugo-next.eu.org/muse/) | [迷雾](https://preview.hugo-next.eu.org/mist/) | [双鱼座](https://preview.hugo-next.eu.org/pisces/) |  |
|
||||
| 正式版本 | [双子座](https://hugo-next.eu.org/) | [冥想](https://hugo-next.eu.org/muse/) | [迷雾](https://hugo-next.eu.org/mist/) | [双鱼座](https://hugo-next.eu.org/pisces/) |  |
|
||||
|
||||
> 开发版本： 所有的新功能开发都会在此第一时间发布预览
|
||||
> 正式版本： 只有测试稳定且符合要求的功能才会正式发布
|
||||
|
||||
## 快速开始
|
||||
|
||||
在使用 `Hugo NexT` 主题之前，请确认你的电脑上已经安装 `Git` 和 `Hugo Extened` 两款软件，然后通过 `submodule` 模式引用本主题，参考如下命令：
|
||||
|
||||
```shell
|
||||
$ hugo new site hugo-next-exmaple
|
||||
$ cd hugo-next-exmaple
|
||||
$ git init
|
||||
$ hugo submodule add https://github.com/hugo-next/hugo-theme-next.git themes/hugo-theme-next
|
||||
$ cp -r themes/hugo-theme-next/exampleSite/* .
|
||||
$ rm -rf config.toml
|
||||
$ hugo server
|
||||
```
|
||||
打开浏览器，在地址栏输入 http://127.0.0.1:1313/ 查看主题效果，祝你好运！:tada::tada::tada:
|
||||
|
||||
> 本主题的代码同时也同步到 `Gitee` 仓库，在国内环境可切换用 [https://gitee.com/hugo-next/hugo-theme-next.git](https://gitee.com/hugo-next/hugo-theme-next.git) 镜像速度更快，也更稳定。
|
||||
|
||||
## 发表新文章
|
||||
|
||||
主题已经配置了默认的文章模板，建议使用如下 Hugo 命令快速创建新的文章：
|
||||
|
||||
```sh
|
||||
$ hugo new posts/hello-world.md
|
||||
```
|
||||
|
||||
关于文章头部的那些标记作用的说明参考如下：
|
||||
|
||||
|
||||
```yml
|
||||
---
|
||||
# 文章标题
|
||||
title: "{{ replace .Name "-" " " | title }}"
|
||||
# 文章内容摘要
|
||||
description: "{{ .Name }}"
|
||||
# 文章内容关键字
|
||||
keywords: "{{replace .Name "-" ","}}"
|
||||
# 发表日期
|
||||
date: {{ .Date }}
|
||||
# 最后修改日期
|
||||
lastmod: {{ .Date }}
|
||||
# 分类
|
||||
categories:
|
||||
-
|
||||
# 标签
|
||||
tags:
|
||||
-
|
||||
-
|
||||
|
||||
# 原文作者
|
||||
#author:
|
||||
# 原文链接
|
||||
#link:
|
||||
# 图片链接，用在open graph和twitter卡片上
|
||||
#imgs:
|
||||
# 在首页展开内容
|
||||
#expand: true
|
||||
# 外部链接地址，访问时直接跳转
|
||||
#extlink:
|
||||
# 在当前页面开启或关闭评论功能
|
||||
#comment:
|
||||
# enable: false
|
||||
# 开启文章目录功能
|
||||
#toc: false
|
||||
# 绝对访问路径
|
||||
#url: "{{ lower .Name }}.html"
|
||||
# 开启文章置顶，数字越小越靠前
|
||||
#weight: 1
|
||||
---
|
||||
```
|
||||
|
||||
## 使用反馈
|
||||
|
||||
- 加入 [GitHub Discussions](https://github.com/hugo-next/hugo-theme-next/discussions) 或 [Gitter](https://gitter.im/hugo-next/community) 在线讨论 :beers:
|
||||
- [GitHub Issues](https://github.com/hugo-next/hugo-theme-next/issues/new?labels=Bug&template=bug-report.md) 提交错误报告 :bug:
|
||||
- [GitHub Feature](https://github.com/hugo-next/hugo-theme-next/issues/new?labels=Feature+Request&template=feature-request.md) 表新功能的想法 :sparkles:
|
||||
|
||||
## 欢迎加入
|
||||
|
||||
关于本主题的开发进度和后续的发展路线图，可访问 [Hugo NexT V4 Roadmap](https://github.com/hugo-next/hugo-theme-next/issues/9) 查看详情，也欢迎大家参与一起来完善。
|
||||
|
||||
## 许可证
|
||||
|
||||
[MIT License](LICENSE)
|
||||
|
||||
## 致谢
|
||||
|
||||
开发 `Hugo NexT` 主题原本是个人的业余爱好，但没想到网友们这么的热情，感谢有你们的支持，让我们一起来见证它的成长。
|
||||
|
||||
以下是捐助名单列表（按时间顺序）：
|
||||
|
||||
| 捐助时间 | 捐助者 | 捐助方式 | 捐助内容 | 留言 |
|
||||
| :-------: | ------ | ------ | ---- | ---- |
|
||||
| 2021.12.21 | z*y | 微信支付 | ¥18.88 | / |
|
||||
| 2022.05.08 | *泉 | 微信支付 | ¥6.60 | 祝开发next顺利 |
|
||||
Loading…
Reference in New Issue
Block a user