-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
174 additions
and
73 deletions.
There are no files selected for viewing
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,53 @@ | ||
# Zhi | ||
|
||
<a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="45"></a> | ||
|
||
✨ **This workspace has been generated by [Nx, a Smart, fast and extensible build system.](https://nx.dev)** ✨ | ||
|
||
## Understand this workspace | ||
|
||
Run `nx graph` to see a diagram of the dependencies of the projects. | ||
|
||
## Remote caching | ||
|
||
Run `npx nx connect-to-nx-cloud` to enable [remote caching](https://nx.app) and make CI faster. | ||
|
||
## Further help | ||
|
||
Visit the [Nx Documentation](https://nx.dev) to learn more. | ||
|
||
## Components | ||
|
||
### commitlint | ||
|
||
1 | ||
|
||
https://www.npmjs.com/package/@commitlint/cz-commitlint | ||
|
||
```bash | ||
npm install --save-dev @commitlint/config-angular @commitlint/cz-commitlint commitizen inquirer@8 | ||
## commitlint.config.js | ||
``` | ||
|
||
2 package.json | ||
|
||
or | ||
|
||
``` | ||
{ | ||
"scripts": { | ||
"commit": "git-cz" | ||
}, | ||
"config": { | ||
"commitizen": { | ||
"path": "@commitlint/cz-commitlint" | ||
} | ||
} | ||
} | ||
``` | ||
|
||
3 | ||
```bash | ||
git add -A | ||
npm run commit | ||
``` |
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,81 +1,25 @@ | ||
# Turborepo starter | ||
# Zhi | ||
|
||
This is an official starter Turborepo. | ||
🛍️ A series of widgets, plugins and themes based on siyuan-note | ||
|
||
## Using this example | ||
[中文版](README_zh_CN.md) | ||
|
||
Run the following command: | ||
[![dev checks](https://img.shields.io/github/checks-status/terwer/zhi/dev?label=build)](https://github.com/terwer/zhi/tree/dev) | ||
![version](https://img.shields.io/github/release/terwer/zhi.svg?style=flat-square) | ||
![license](https://img.shields.io/badge/license-GPL-blue.svg?style=popout-square) | ||
|
||
```sh | ||
npx create-turbo@latest | ||
``` | ||
> ⚠️ WARNING: Due to `theme.js` will be removed, this theme cannot be published yet.I will publish style-based theme, plugins, widgets later. | ||
## What's inside? | ||
## Zhi family | ||
|
||
This Turborepo includes the following packages/apps: | ||
- zhi-framework - Core framework (originally unpublished zhi theme, relying on theme.js) <sup> not on the shelf, can explore </sup> | ||
- zhi-theme - Style-based theme <sup> in progress </sup> | ||
- zhi-widget-publisher (sy-post-publisher) - Siyuan note publishing tool <sup> has been put on the shelf official pendant market </sup> | ||
- zhi-plugin-bridge-publisher - Siyuan note release tool plugin bridge version <sup> has been put on the third-party plug-in market </sup> | ||
- zhi-plugin-publisher - Siyuan Note publishing tool plug-in edition <sup> in progress </sup> | ||
- zhi-widget-blog - Blog widget version based on Siyuan Note API <sup> in progress </sup> | ||
- zhi-plugin-blog - Blog plug-in version based on Siyuan Note API <sup> in progress </sup> | ||
|
||
### Apps and Packages | ||
## Acknowledgments | ||
|
||
- `docs`: a [Next.js](https://nextjs.org/) app | ||
- `web`: another [Next.js](https://nextjs.org/) app | ||
- `ui`: a stub React component library shared by both `web` and `docs` applications | ||
- `eslint-config-custom`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`) | ||
- `tsconfig`: `tsconfig.json`s used throughout the monorepo | ||
|
||
Each package/app is 100% [TypeScript](https://www.typescriptlang.org/). | ||
|
||
### Utilities | ||
|
||
This Turborepo has some additional tools already setup for you: | ||
|
||
- [TypeScript](https://www.typescriptlang.org/) for static type checking | ||
- [ESLint](https://eslint.org/) for code linting | ||
- [Prettier](https://prettier.io) for code formatting | ||
|
||
### Build | ||
|
||
To build all apps and packages, run the following command: | ||
|
||
``` | ||
cd my-turborepo | ||
pnpm build | ||
``` | ||
|
||
### Develop | ||
|
||
To develop all apps and packages, run the following command: | ||
|
||
``` | ||
cd my-turborepo | ||
pnpm dev | ||
``` | ||
|
||
### Remote Caching | ||
|
||
Turborepo can use a technique known as [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines. | ||
|
||
By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup), then enter the following commands: | ||
|
||
``` | ||
cd my-turborepo | ||
npx turbo login | ||
``` | ||
|
||
This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview). | ||
|
||
Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo: | ||
|
||
``` | ||
npx turbo link | ||
``` | ||
|
||
## Useful Links | ||
|
||
Learn more about the power of Turborepo: | ||
|
||
- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks) | ||
- [Caching](https://turbo.build/repo/docs/core-concepts/caching) | ||
- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) | ||
- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering) | ||
- [Configuration Options](https://turbo.build/repo/docs/reference/configuration) | ||
- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference) | ||
Thanks to [zuoez02](https://github.com/zuoez02/siyuan-plugin-system) for providing the plugin system. |
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 @@ | ||
# Zhi | ||
|
||
🛍️ A series of widgets, plugins and themes based on siyuan-note | ||
|
||
[![](https://img.shields.io/badge/api-docs-green)](https://zhi.terwer.space) | ||
[![dev checks](https://img.shields.io/github/checks-status/terwer/zhi/dev?label=build)](https://github.com/terwer/zhi/tree/dev) | ||
![version](https://img.shields.io/github/release/terwer/zhi.svg?style=flat-square) | ||
![license](https://img.shields.io/badge/license-GPL-blue.svg?style=popout-square) | ||
|
||
[![](https://img.shields.io/badge/build-assets-green)](https://github.com/terwer/zhi) | ||
[![](https://img.shields.io/badge/theme-source-red)](https://github.com/terwer/zhi/tree/dev/packages/zhi-mini) | ||
[![](https://img.shields.io/badge/dynamic-blog-blue)](https://github.com/terwer/zhi/tree/dev/packages/zhi-blog) | ||
[![](https://img.shields.io/badge/static-blog-purple)](https://github.com/terwer/zhi/tree/dev/packages/zhi-blog-astro) | ||
|
||
~~> ⚠️ WARNING 1: Attention: The `zhi` theme only supports the `2.7.6+` version of [siyuan-note](https://github.com/siyuan-note/siyuan) , and the plugin system only supports `2.8.1+`. Otherwise, you need to upgrade [siyuan-note](https://github.com/siyuan-note/siyuan) to a new version.~~ | ||
|
||
~~> ⚠️ WARNING 2: `1.0.0` is an available version in the early stage, and the function is not comprehensive yet. It is only used for testing and welcomes valuable opinions through issuing. Please refer to [core features](#core-features) for this version's characteristics.~~ | ||
|
||
~~> ⚠️ WARNING 3: The plugin system is set to `security mode` by default, and you need to click on the settings menu in the upper right corner to turn off the security mode before you can activate the plugin system.~~ | ||
|
||
~~> ⚠️ WARNING 4: Except for the theme's core plugins, all plugins are disabled by default and need to be enabled in the plugin list before the first use.~~ | ||
|
||
> ⚠️ WARNING 4: Due to `theme.js` will be removed, this theme cannot be published yet.I will publish style-based theme, plugins, widgets later. | ||
## Zhi family | ||
|
||
- zhi-framework | ||
- zhi-theme | ||
- zhi-widget-publisher (sy-post-publisher) | ||
- zhi-plugin-publisher | ||
- zhi-widget-blog | ||
- zhi-plugin-blog | ||
|
||
## Key benefits | ||
|
||
- Integrated blog feature based on the Siyuan API | ||
|
||
- No publishing, no configuration, ready to use out of the box | ||
|
||
- Plugin system bundled, by design | ||
|
||
## Quick start | ||
|
||
You can download the `zhi` theme directly in the Market of siyuan-note, and then select the `zhi` theme | ||
in `Settings` - `Appearance` - `Theme` to change the appearance of the notebook. | ||
|
||
Note: `zhi` theme only supports siyuan-note `2.7.6+`, or you must upgrade siyuan-note first. | ||
|
||
## Design Philosophy | ||
|
||
- The theme core should be kept lightweight and compact as much as possible. | ||
- Plugins should be used as much as possible to implement functions. | ||
- Plugin functions should be single-purpose to avoid brainless accumulation of functions. | ||
- Components should be kept as reusable as possible. | ||
|
||
## Core Features | ||
|
||
The theme is inspired by `Zhihu` but not limited to its style. The appearance optimization includes but is not limited | ||
to: | ||
|
||
- Font style beautification, using `Open Sans` for English and `LXGW WenKai` for Chinese | ||
- Background color optimization, overall layout and spacing optimization | ||
- Code block beautification, similar to the Mac window style | ||
- It natively supports the plugin system and comes with many built-in plugins. The plugin system is supported by | ||
community developers. | ||
- Siyuan-note publishing tool plugin | ||
- Document image background automatic transparency plugin | ||
- Blog plugin | ||
- It can handle both the theme and the preview. Installing the zhi theme is equivalent to installing an additional | ||
plugin system and an online blog. | ||
- SPA blog homepage( `enabled and bundled by default` ): http://127.0.0.1:6806/appearance/themes/zhi/web/blog/ <sup>simple</sup> | ||
- SSR blog homepage( `⚠️ need to be enabled manually` ): http://127.0.0.1:6806/appearance/themes/zhi/server/blog/ <sup>seo friendly</sup> | ||
|
||
> Note: 🌹 The plugin system is provided by enthusiastic community developers. Please understand the relevant mechanisms in | ||
> detail before using. | ||
## Technical Roadmap | ||
|
||
[development](DEVELOPMENT.md) | ||
|
||
## Acknowledgments | ||
|
||
Thanks to [zuoez02](https://github.com/zuoez02/siyuan-plugin-system) for providing the plugin system. |
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,21 @@ | ||
# Zhi | ||
|
||
🛍️ 基于思源笔记的一系列框架、插件、挂件、主题等 | ||
|
||
[English](README.md) | ||
|
||
[![dev checks](https://img.shields.io/github/checks-status/terwer/zhi/dev?label=build)](https://github.com/terwer/zhi/tree/dev) | ||
![version](https://img.shields.io/github/release/terwer/zhi.svg?style=flat-square) | ||
![license](https://img.shields.io/badge/license-GPL-blue.svg?style=popout-square) | ||
|
||
> ⚠️警告:由于 `theme.js` 将被删除,这个主题不能发布。稍后我会发布基于样式的主题、插件和小部件等。 | ||
## Zhi 项目家族 | ||
|
||
- zhi-framework - 核心框架( 原未发布的 zhi 主题,依赖 theme.js ) <sup>未上架,可自行探索</sup> | ||
- zhi-theme - 基于样式的主题 <sup>进行中</sup> | ||
- zhi-widget-publisher (sy-post-publisher) - 思源笔记发布工具 <sup>已上架官方挂件集市</sup> | ||
- zhi-plugin-bridge-publisher - 思源笔记发布工具插件桥接版 <sup>已上架第三方插件市场</sup> | ||
- zhi-plugin-publisher - 思源笔记发布工具插件版 <sup>进行中</sup> | ||
- zhi-widget-blog - 基于思源笔记API的博客挂件版 <sup>进行中</sup> | ||
- zhi-plugin-blog - 基于思源笔记API的博客插件版 <sup>进行中</sup> |