From ecb8e1506a77c6beb72de9a4cef6e7122c762558 Mon Sep 17 00:00:00 2001 From: SeeLey Wang Date: Sat, 12 Oct 2024 18:33:59 +0800 Subject: [PATCH 1/2] update readme --- CHANGELOG.md | 34 +++++++++++++++++++++++++++++++ README.md | 3 +-- README_zh.md => docs/README_zh.md | 1 - 3 files changed, 35 insertions(+), 3 deletions(-) create mode 100644 CHANGELOG.md rename README_zh.md => docs/README_zh.md (99%) diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..4775882 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,34 @@ +# Changelog + +## [Unreleased] + +### Added + +- Support for style extensions on article pages +- Support for online editing + +### Changed + +- Refactored both frontend and backend + +### Fixed + +- Fixed backend bug + +## [0.2.2] - 2024-10-12 + +### Added + +- Support for mkdocs material style admonition + - Support for `!!!` & `???` +- Switched article page rendering to client-side + +### Fixed + +- Fixed an admonition bug: pointer overflow issue when consecutive admonition blocks are used + +## [0.2.0] - 2024-09-20 + +### Added + +- Support for branch switching, allowing a specific branch to be specified when creating a repository, making it easier to preview the display before merging into the mainline diff --git a/README.md b/README.md index 7cc5977..0e4d97a 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ -[中文版](README_zh.md) +[中文版](docs/README_zh.md) ------

Welcome to ZBook, a fully open-source full-stack knowledge base management software for teams.

@@ -98,7 +98,6 @@ ZBook plans to support the following features: - [x] MkDocs-style collapsible admonitions. - [ ] MkDocs-style theme extensions. - [ ] GitHub-style admonitions. -- [ ] Online Editing✍️ ## Deployment diff --git a/README_zh.md b/docs/README_zh.md similarity index 99% rename from README_zh.md rename to docs/README_zh.md index a7fc635..6c74c37 100644 --- a/README_zh.md +++ b/docs/README_zh.md @@ -99,7 +99,6 @@ zbook计划支持如下功能: - [x] mkdocs 风格的折叠式admonition - [ ] 类似mkdocs的风格扩展 - [ ] github 风格的admonition -- [ ] 在线编辑✍️ ## 部署 From 691a90db9b8489488199eac6da504d2e6d716342 Mon Sep 17 00:00:00 2001 From: SeeLey Wang Date: Sat, 12 Oct 2024 18:38:38 +0800 Subject: [PATCH 2/2] update changelog --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4775882..b110a67 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,7 @@ # Changelog +All notable changes to this project will be documented in this file. + ## [Unreleased] ### Added