Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zizdlp/zbook
ZBook,An alternative solution for team-level GitBook
https://github.com/zizdlp/zbook
full-stack gitbook goldmark knowledge-base markdown markdown-documentation markdown-to-html nextjs self-hosted zbook
Last synced: 5 days ago
JSON representation
ZBook,An alternative solution for team-level GitBook
- Host: GitHub
- URL: https://github.com/zizdlp/zbook
- Owner: zizdlp
- License: gpl-3.0
- Created: 2024-08-11T13:44:38.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-25T00:10:38.000Z (14 days ago)
- Last Synced: 2024-10-25T10:44:39.550Z (13 days ago)
- Topics: full-stack, gitbook, goldmark, knowledge-base, markdown, markdown-documentation, markdown-to-html, nextjs, self-hosted, zbook
- Language: TypeScript
- Homepage: https://zizdlp.com
- Size: 3.68 MB
- Stars: 125
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Roadmap: ROADMAP.md
Awesome Lists containing this project
- jimsghstars - zizdlp/zbook - ZBook,An alternative solution for team-level GitBook (TypeScript)
README
ZBook
Documentation - Helm Chart - Discord - Youtube
[](https://github.com/zizdlp/zbook/actions/workflows/build_main.yml)
[](https://github.com/zizdlp/zbook/actions/workflows/test_backend.yml)
[](https://github.com/zizdlp/zbook/actions/workflows/test_frontend.yml)
[](https://dl.circleci.com/status-badge/redirect/gh/zizdlp/zbook/tree/release)
[δΈζη](docs/README_zh.md)
------
Welcome to ZBook, a fully open-source full-stack knowledge base management software for teams.
This repository contains the open-source code used to render and serve ZBook
## Table of Contents
- [Getting Started](#getting-started)
- [Features](#features)
- [Deployment](#deployment)
- [Licensing](#license)
- [Acknowledgements](#acknowledgements)
## Getting Started
To run a local version of this project, please follow these simple steps.
### Prerequisites
- docker & docker-compose
### Set up
1. Clone the repo into a **public** GitHub repository. If you plan to distribute the code, keep the source code public to comply with GNU GPLv3.
```shell
git clone https://github.com/zizdlp/zbook.git
```
2. Build & run your local development server
```shell
make compose_pull
```
3. Then open the space in your web browser, using
4. π» To use email services and third-party account login, please apply first. For details, please refer to [ZBook Documentation](https://github.com/zizdlp/zbook-docs).
### CI and testing
All pull-requests will be tested against both visual and performances testing to prevent regressions.
ZBook is fully open-source and built on top of [Next.js](https://nextjs.org/).
### Types of contributions
We encourage you to contribute to ZBook to help us build the best tool for documenting technical knowledge. If you're looking for some quick ways to contribute, continue reading to learn more about popular contributions.
#### Translations
The ZBook UI is rendered using a set of translation files found in [`zbook_frontend/messages`](/zbook_frontend/messages/). We welcome all additional translations for the UI.
If you are submitting new language support, please first refer to the documentation [Language Support](https://github.com/zizdlp/zbook-docs/blob/main/Development/LanguageSupport.md) and follow the necessary procedures. You can refer to these commits: `ec05f3a1d75d3f88619489a44f77104a37295ba3`,
`92e4b2933a9e23d08c15042b9b9085f4fea556f7`
#### Bugs
Encounter a bug or find an issue you'd like to fix? Helping us fix issues related to ZBook greatly improves the experience for everyone. Head to the issues section of this repository to learn more about the types of bugs you can already help out with.
## Features
Support:
- **full-stack**: a full-stack software utilizing Next.js and Tailwind CSS for the frontend, Golang gRPC for backend services, PostgreSQL for database management, and MinIO for storage, and WebSocket for real-time messaging notifications.
- **multi-level permission management**: Support for various repository visibility options including public, login-only, selected users, and creator-only access.
- **Comments**
- **Notifications**
- **open source**
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:
- [x] Branch switching, allowing users to preview specific branches before merging into the main branch.
- [x] MkDocs-style collapsible admonitions.
- [ ] MkDocs-style theme extensions.
- [ ] GitHub-style 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).
## License
Distributed under the [GNU GPLv3 License](https://github.com/zizdlp/zbook/LICENSE).
If you plan to distribute the code, you must the source code public to comply with GNU GPLv3.
See `LICENSE` for more information.
## Acknowledgements
ZBook wouldn't be possible without these projects:
- [Next.js](https://nextjs.org/)
- [Tailwind CSS](https://tailwindcss.com/)
- [GoldMark](https://github.com/yuin/goldmark)
## Contributors
