mirror of
https://github.com/hugo-fixit/FixIt.git
synced 2026-08-24 15:28:57 +00:00
docs: update v1 migration guide and fixit-encrypt repository
- Update README warning to point to v1 migration guide - Update version compatibility check for v1.0.0 - Remove temporary v1 development warning - Update fixit-encrypt repository link in encrypt package README
This commit is contained in:
@@ -32,9 +32,8 @@
|
||||
[](https://gitee.com/lruihao/FixIt/stargazers)
|
||||
|
||||
> [!WARNING]
|
||||
> **Version v0.x only accepts bug fixes. For new feature submissions, please develop on the [v1](https://github.com/hugo-fixit/FixIt/tree/v1) branch.**
|
||||
>
|
||||
> Version 1.0 is planned for release in **the first half of 2027**. Welcome to join the development and discussion! See [v1 Milestone](https://github.com/hugo-fixit/FixIt/milestone/8) for details.
|
||||
> **The `main` branch contains the v1 code. For upgrade instructions, see the [v1 migration guide](https://fixit.lruihao.cn/guides/upgrade-to-v1/).**\
|
||||
> Version 1.0.0 is planned for release in **the first half of 2027**. Welcome to join the development and [discussion](https://github.com/orgs/hugo-fixit/discussions/723)!
|
||||
|
||||
## Live Preview
|
||||
|
||||
|
||||
+2
-3
@@ -32,9 +32,8 @@
|
||||
[](https://gitee.com/lruihao/FixIt/stargazers)
|
||||
|
||||
> [!WARNING]
|
||||
> **v0.x 版本仅接受 bug 修复,如需提交新功能,请基于 [v1](https://github.com/hugo-fixit/FixIt/tree/v1) 分支开发。**
|
||||
>
|
||||
> 1.0 版本计划在 **2027 年上半年** 发布,欢迎加入开发和讨论!详见 [v1 里程碑](https://github.com/hugo-fixit/FixIt/milestone/8)。
|
||||
> **当前 `main` 分支包含 v1 代码,升级详见 [v1 升级指南](https://fixit.lruihao.cn/guides/upgrade-to-v1/)**。\
|
||||
> 1.0 版本计划在 **2027 年上半年** 发布,欢迎加入开发和 [讨论](https://github.com/orgs/hugo-fixit/discussions/723)!
|
||||
|
||||
## 即时预览
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@
|
||||
{{- if .Site.Language.IsDefault -}}
|
||||
{{- if not .Site.Params.version -}}
|
||||
{{- errorf "FixIt %v\n%v\n\n" $version (T "init.configurationError") -}}
|
||||
{{- else if gt "0.2.0" (strings.TrimPrefix "v" .Site.Params.version) -}}
|
||||
{{- else if gt "1.0.0" (strings.TrimPrefix "v" .Site.Params.version) -}}
|
||||
{{- errorf "FixIt %v\n%v\n\n" $version (dict "From" .Site.Params.version "To" $version | T "init.compatibilityError") -}}
|
||||
{{- end -}}
|
||||
{{- if gt (len (findRE "^v[0-9]+\\.[0-9]+\\.[0-9]+-[0-9a-f]+$" $version)) 0 -}}
|
||||
@@ -41,10 +41,6 @@
|
||||
{{- if (gt $latest $version) | and $devOpts.c4u -}}
|
||||
{{- warnf "FixIt %v (⬆️ %v)\n%v`git submodule update --remote --merge`\n\n" $version $latest (T "init.quicklyUpgrade") -}}
|
||||
{{- end -}}
|
||||
{{- /* [todo] remove this temporary warning after v1.0.0 release */ -}}
|
||||
{{- if hasPrefix $version "v1." -}}
|
||||
{{- warnidf "warning-v1-dev" "FixIt %v\n⚠️ You are using a v1.0.0 development version, which may contain breaking changes.\nIt is recommended to use the latest stable release v0.4.5: https://github.com/hugo-fixit/FixIt/releases/tag/v0.4.5\n" $version -}}
|
||||
{{- end -}}
|
||||
{{- end -}}
|
||||
|
||||
{{- hugo.Store.Set "latest" $latest -}}
|
||||
|
||||
@@ -8,7 +8,7 @@
|
||||
Called from: layouts/baseof.html.
|
||||
*/ -}}
|
||||
|
||||
{{- hugo.Store.Set "version" "v1.0.0-mrx1kx57" -}}
|
||||
{{- hugo.Store.Set "version" "v1.0.0-mrygaidy" -}}
|
||||
{{- .Store.Set "this" dict -}}
|
||||
|
||||
{{- partial "init/detection-env.html" . -}}
|
||||
|
||||
@@ -99,14 +99,12 @@ The per-template cost is constant regardless of file count or content size, as P
|
||||
|
||||
The current implementation is in **Node.js (TypeScript)**. For environments where Node.js performance is a bottleneck, community-maintained implementations in other languages are welcome:
|
||||
|
||||
| Language | Status | Repository |
|
||||
| -------- | --------- | ------------------ |
|
||||
| Node.js | Available | hugo-fixit/FixIt |
|
||||
| Go | Available | [fixit-encrypt.go] |
|
||||
| Python | Planned | — |
|
||||
| Rust | Planned | — |
|
||||
| Language | Status | Repository |
|
||||
| -------- | --------- | -------------------------- |
|
||||
| Node.js | Available | hugo-fixit/FixIt |
|
||||
| Go | Available | [hugo-fixit/fixit-encrypt] |
|
||||
|
||||
[fixit-encrypt.go]: https://github.com/hugo-fixit/fixit-encrypt.go
|
||||
[hugo-fixit/fixit-encrypt]: https://github.com/hugo-fixit/fixit-encrypt
|
||||
|
||||
If you have implemented `fixit-encrypt` in another language, please open a PR to add it to this list.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user