Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
BroKun committed Nov 1, 2023
1 parent a6c36fe commit 20d56fc
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 14 deletions.
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Development

## init

```
pnpm bootstrap
```

## dev & doc

```
pnpm run docs
```

## release

```
pnpm changeset
pnpm changeset version
pnpm changeset publish
```
34 changes: 20 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,29 @@
# libro

[![Code: CI](https://github.com/difizen/libro/actions/workflows/ci.yml/badge.svg)](https://github.com/difizen/libro/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/difizen/libro/graph/badge.svg?token=8LWLNZK78Z)](https://codecov.io/gh/difizen/libro)

# init
一个 notebook 编辑器和产品前端解决方案。

```
pnpm bootstrap
```
- 方便自定义扩展和二次开发
- 基于 react 易于集成
- 兼容原生 ipynb 文件

# dev & doc
![image](https://mdn.alipayobjects.com/huamei_hdnzbp/afts/img/A*x8k3TbwOJqoAAAAAAAAAAAAADjOxAQ/original)

```
pnpm run docs
```
## 模块

# release
- [内核](./packages/libro-core/README.md)
- [kernel](./packages/libro-kernel/README.md)
- [markdown cell](./packages/libro-codemirror-markdown-cell/README.md)
- [code cell](./packages/libro-codemirror-code-cell/README.md)
- [raw cell](./packages/libro-codemirror-raw-cell/README.md)
- [输出](./packages/libro-output/README.md)
- [mime 渲染](./packages/libro-rendermime/README.md)
- [大纲](./packages/libro-toc/README.md)
- [全文搜索](./packages/libro-search/README.md)
- [本地化](./packages/libro-l10n/README.md)

```
pnpm changeset
pnpm changeset version
pnpm changeset publish
```
## 贡献代码

请查阅 [CONTRIBUTING.md](./CONTRIBUTING.md)

0 comments on commit 20d56fc

Please sign in to comment.