Skip to content

Commit

Permalink
add todo
Browse files Browse the repository at this point in the history
  • Loading branch information
zizdlp committed Sep 13, 2024
1 parent 53114e8 commit 35a0737
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,15 @@ Not Support:

ZBook does **not support online editing**. We believe that tools like Git in local environments such as VS Code and Typora are sufficient for editing and collaborating on content. **Online editing is not essential** in our view. Additionally, enabling online editing would require granting write permissions to Git repositories, which could pose **security risks**.

### TODO

ZBook plans to support the following features:

- [ ] Branch switching, allowing users to preview specific branches before merging into the main branch.
- [ ] MkDocs-style theme extensions.
- [ ] GitHub-style admonitions.
- [ ] MkDocs-style collapsible admonitions.

## Deployment

For privacy and other reasons (for private repositories, you may need to input an access token; although GitHub supports fine-grained access tokens that can grant specific permissions to specific repositories, such as read-only), we encourage you to deploy ZBook yourself. You can use docker-compose or a k8s cluster for deployment. For details, please refer to the [ZBook Documentation](https://github.com/zizdlp/zbook-docs).
Expand Down
9 changes: 9 additions & 0 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,15 @@ ZBook 的用户界面使用一组翻译文件进行渲染,这些文件可以

ZBook 不支持**在线编辑**。我们认为 Git 在本地环境如 VS Code 和 Typora 中的工具足以用于编辑和协作内容。在线编辑不是必需的。此外,启用在线编辑需要授予 Git 仓库写权限,这可能带来**安全风险**

### TODO

zbook计划支持如下功能:

- [ ] 分支切换,动机是合并main分支之前,可以先查看特定分支的显示效果
- [ ] 类似mkdocs的风格扩展
- [ ] github 风格的admonition
- [ ] mkdocs 风格的折叠式admonition

## 部署

由于隐私和其他原因(对于私人仓库,你可能需要输入访问令牌;虽然 GitHub 支持细粒度访问令牌,可以授予特定仓库的特定权限,例如只读),我们鼓励你自行部署 ZBook。你可以使用 Docker Compose 或 k8s 集群进行部署。详情请参阅 [ZBook 文档](https://github.com/zizdlp/zbook-docs)。
Expand Down

0 comments on commit 35a0737

Please sign in to comment.