-
-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* dev: 🔥 Feat: remove `params.dev.githubtoken` adn replace with environment variable `HUGO_PARAMS_GHTOKEN` Docs: 完善 link shortcode (hugo-fixit/FixIt#391) Docs: 更新 Gravatar 镜像 Docs: 更新打赏设置 🔧 Chore: remove unnecessary parameters in package.json Docs: 贡献文档关闭推荐阅读功能 Fix: 兼容低版本 hugo relref 写法 Docs: 贡献指南加上封面图 Docs: 完善贡献文档 Docs: 增加贡献文档(未完成)
- Loading branch information
Showing
33 changed files
with
614 additions
and
98 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
# ------------------------------------------------------------------------------------- | ||
# Theme Core Configuration | ||
# See: https://fixit.lruihao.cn/theme-documentation-basics/#site-configuration | ||
# ------------------------------------------------------------------------------------- | ||
|
||
# FixIt 0.2.15 | NEW Developer options | ||
# Configure with environment variable HUGO_PARAMS_GHTOKEN=xxx, see https://gohugo.io/functions/os/getenv/#examples | ||
[dev] | ||
enable = false | ||
# Check for updates | ||
c4u = true | ||
# Mobile Devtools confi | ||
[dev.mDevtools] | ||
enable = false | ||
# "vConsole", "eruda" supported | ||
type = "vConsole" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
title: Contributing | ||
date: 2024-04-25T20:17:52+08:00 | ||
description: Hugo FixIt is eager for enthusiasm and participation from the open-source community. We need your support. | ||
keywords: | ||
- hugo-fixit | ||
- FixIt | ||
- Contribution | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
title: Develop theme components (TODO) | ||
date: 2024-04-25T20:30:45+08:00 | ||
type: posts | ||
collections: | ||
- Contributing | ||
draft: true | ||
hiddenFromHomePage: true | ||
reward: true | ||
related: | ||
enable: false | ||
--- | ||
<!-- markdownlint-disable-file reference-links-images --> | ||
If you’ve built a Hugo theme components and want to contribute back to the Hugo FixIt Community, please share it with us. | ||
|
||
<!--more--> | ||
|
||
Visit [this page][components] to browse a collection of themes components created by the Hugo FixIt community. | ||
|
||
## References | ||
|
||
Head to the [References][references] page for more information. | ||
|
||
<!-- link reference definition --> | ||
[components]: {{< relref "/components/" >}} | ||
[references]: {{< relref "/references/" >}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
--- | ||
title: Develop FixIt theme | ||
date: 2024-04-25T20:30:43+08:00 | ||
type: posts | ||
collections: | ||
- Contributing | ||
hiddenFromHomePage: true | ||
reward: true | ||
related: | ||
enable: false | ||
--- | ||
|
||
Contribute to the development of FixIt. | ||
|
||
<!--more--> | ||
|
||
## Introduction | ||
|
||
You can contribute to the FixIt theme project by: | ||
|
||
- Answering questions on the [discussions][discussions] page | ||
- Squashing [bugs][bugs] | ||
- Developing [new features][features] | ||
|
||
For a complete guide to contributing to FixIt, see the [Contribution Guide][contribution-guide]. | ||
|
||
## Prerequisites | ||
|
||
To contribute to the development of the FixIt theme, you need to: | ||
|
||
- Install [Hugo][hugo] with the extended version | ||
- Install [Go][go] | ||
- Install [Git][git] | ||
- Install [Node.js][node] above version 18.0.0 | ||
|
||
## References | ||
<!-- markdownlint-disable-file reference-links-images --> | ||
Head to the [References][references] page for more information. | ||
|
||
<!-- link reference definition --> | ||
[discussions]: https://github.com/orgs/hugo-fixit/discussions | ||
[bugs]: https://github.com/hugo-fixit/FixIt/issues?q=is%3Aopen+is%3Aissue+label%3Abug | ||
[features]: https://github.com/hugo-fixit/FixIt/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement | ||
[contribution-guide]: https://github.com/hugo-fixit/FixIt/blob/master/CONTRIBUTING.md | ||
[hugo]: https://gohugo.io/installation/ | ||
[go]: https://go.dev/doc/install | ||
[git]: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git | ||
[node]: https://nodejs.org/en/download/ | ||
[references]: {{< relref "/references/" >}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
--- | ||
title: Improve documentation | ||
date: 2024-04-25T20:30:44+08:00 | ||
type: posts | ||
collections: | ||
- Contributing | ||
hiddenFromHomePage: true | ||
reward: true | ||
related: | ||
enable: false | ||
--- | ||
|
||
Help us to improve the documentation by identifying issues and suggesting changes. | ||
|
||
<!--more--> | ||
|
||
## Introduction | ||
|
||
We welcome corrections and improvements to the documentation. Please note that the documentation resides in its own repository, separate from the project repository. | ||
|
||
For corrections and improvements to the current documentation, please submit issues and pull requests to the [documentation repository][docs]. | ||
|
||
You can also: | ||
<!-- markdownlint-disable-file reference-links-images --> | ||
- Submit [showcase][showcase] by editing the `data/friends.yml` file | ||
- Submit [theme components][components] by editing the `data/projects.lang.yml` file | ||
|
||
## Prerequisites | ||
|
||
To contribute to the documentation, you need to: | ||
|
||
- Install [Hugo][hugo] with the extended version | ||
- Install [Go][go] | ||
- Install [Git][git] | ||
- Install [Node.js][node] above version 18.0.0 | ||
|
||
## Guidelines | ||
|
||
First, fork this repository by clicking the fork button. | ||
|
||
Next, clone your forked repo. | ||
|
||
```bash | ||
git clone https://github.com/hugo-fixit/docs.git fixit-docs && cd fixit-docs | ||
``` | ||
|
||
Then, install the dev dependencies. | ||
|
||
```bash | ||
npm install | ||
``` | ||
|
||
And now you are ready to go! | ||
|
||
Here are some useful commands. | ||
|
||
```bash | ||
# run a local debugging server with watch | ||
npm run server | ||
# run a local debugging server with watch in production environment | ||
npm run server:production | ||
# see Edit the theme section | ||
npm run server:development | ||
``` | ||
|
||
## Edit the theme | ||
|
||
If you want to do docs-related theme changes, the simplest way is to have both `fixit-docs` and `FixIt` cloned as sibling directories, and then run: | ||
|
||
```bash | ||
HUGO_MODULE_WORKSPACE=hugo.work hugo server --ignoreVendorPaths "**" | ||
``` | ||
|
||
Finally, create a new pull request at <https://github.com/hugo-fixit/docs/pulls> to submit your contribution 🎉 | ||
|
||
<!-- link reference definition --> | ||
[docs]: https://github.com/hugo-fixit/docs | ||
[hugo]: https://gohugo.io/installation/ | ||
[go]: https://go.dev/doc/install | ||
[git]: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git | ||
[node]: https://nodejs.org/en/download/ | ||
[showcase]: {{< relref path="/showcase" >}} | ||
[components]: {{< relref "/components" >}} |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
title: Contribute to the FixIt project | ||
linkTitle: Overview of contributing | ||
date: 2024-04-25T20:30:42+08:00 | ||
collections: | ||
- Contributing | ||
resources: | ||
- name: featured-image | ||
src: cover.webp | ||
type: posts | ||
pageStyle: wide | ||
reward: true | ||
related: | ||
enable: false | ||
description: Hugo FixIt is eager for enthusiasm and participation from the open-source community. We need your support! | ||
keywords: | ||
- hugo-fixit | ||
- FixIt | ||
- Contribution | ||
--- | ||
|
||
Hugo FixIt is eager for enthusiasm and participation from the open-source community. We need your support! | ||
|
||
<!--more--> | ||
|
||
{{< link "../development" "🔧 Develop FixIt theme" "Contribute to the development of FixIt." true >}} | ||
|
||
--- | ||
|
||
{{< link "../documentation" "📝 Improve documentation" "Help us to improve the documentation by identifying issues and suggesting changes." true >}} | ||
|
||
--- | ||
|
||
{{< link "../components" "🧩 Develop theme components" "Contribute to the development of Hugo FixIt components." true >}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 change: 1 addition & 0 deletions
1
content/en/documentation/content-management/introduction/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
--- | ||
weight: 2 | ||
title: Content Management Overview | ||
date: 2024-04-06T12:57:26+08:00 | ||
type: posts | ||
|
Oops, something went wrong.