diff --git a/README.md b/README.md new file mode 100644 index 00000000..2f9c8cea --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +
+

+ +Slidev + +

+ +

+专为开发者设计的演讲幻灯片工具 🧑‍💻👩‍💻👨‍💻 +

+ +

+NPM version +NPM Downloads +Docs & Demos +Themes +
+GitHub stars +

+ + +# Slidev 中文文档 + +- 📝 [**Markdown 支持**](/guide/syntax.html) —— 使用你最喜欢的编辑器和工作流编写 Markdown 文件 +- 🧑‍💻 [**对开发者友好**](/guide/syntax.html#code-blocks) —— 内置代码高亮、实时编码等功能 +- 🎨 [**可定制主题**](/themes/gallery.html) —— 以 npm 包的形式共享、使用主题 +- 🌈 [**灵活样式**](/guide/syntax.html#embedded-styles) —— 使用 [Windi CSS](https://windicss.org/) 按需使用的实用类和易用的内嵌样式表 +- 🤹 [**交互**](/custom/directory-structure.html#components) —— 无缝嵌入 Vue 组件 +- 🎙 [**演示者模式**](/guide/presenter-mode.html) —— 可以使用另一个窗口,甚至是你的手机来控制幻灯片 +- 🧮 [**LaTeX 支持**](/guide/syntax.html#latex) —— 内置了对 LaTeX 数学公示的支持 +- 📰 [**图表支持**](/guide/syntax.html#diagrams) —— 使用文本描述语言创建图表 +- 🌟 [**图标**](/guide/syntax.html#icons) —— 能够直接从任意图标库中获取图标 +- 💻 [**编辑器**](/guide/editors.html) —— 集成的编辑器,或者使用 [VS Code 扩展](https://github.com/slidevjs/slidev-vscode) +- 🎥 [**录制**](/guide/recording.html) —— 内置录制功能和摄像头视图 +- 📤 [**跨平台**](/guide/exporting.html) —— 能够导出 PDF、PNG 文件,甚至是一个可以托管的单页应用 +- ⚡️ [**快速**](https://vitejs.dev) —— 基于 [Vite](https://vitejs.dev) 的即时重载 +- 🛠 [**可配置**](/custom/config-vite.html) —— 支持使用 Vite 插件、Vue 组件以及任何的 npm 包 + +## 📨 与官网文档同步 + +目前 Slidev 中文文档正在翻译校对过程中(WIP)。 + +**同步原理**:[印记中文](https://github.com/docschina) 的机器人每天会拉取 [Slidev 的官网文档](https://github.com/slidevjs/slidev) 的内容,并发起到 `sync-docs` 分支的 PR。仓库维护者需要每天检查该类型的 PR:如无冲突,可以直接 merge 到 到 `sync-docs` 中 ;若有冲突,需要先解决冲突,再 merge 到 `sync-docs` 中。 + +## 📝 参与贡献 + +贡献者首先 fork 本仓库,基于 `main` 创建新的翻译分支,进行翻译。翻译完成后,发起到 `main` 的 PR,等待 review,review 通过,仓库维护者将 PR merge。 + +若需要本地查看网站效果,可以切换到 `site` 分支,并执行如下命令: + +``` +# 安装依赖,使用 pnpm +$ pnpm install + +# 构建文档,site 分支使用了 Git 的 submodules,执行此命令会同时将 docs-cn 同步到 site 分支 +$ npm run build:docs + +# 启动文档 +$ npm run docs +```