Skip to content

Latest commit

 

History

History
82 lines (62 loc) · 6.18 KB

README.md

File metadata and controls

82 lines (62 loc) · 6.18 KB

Slidev

为开发者打造的演示文稿工具 🧑‍💻👩‍💻👨‍💻

NPM version NPM Downloads Docs & Demos Themes
GitHub stars

Slidev 中文文档

  • 📝 Markdown 支持 —— 使用你最喜欢的编辑器和工作流编写 Markdown 文件
  • 🧑‍💻 对开发者友好 —— 内置代码高亮、实时编码等功能
  • 🎨 可定制主题 —— 以 npm 包的形式共享、使用主题
  • 🌈 灵活样式 —— 使用 Windi CSS 按需使用的实用类和易用的内嵌样式表
  • 🤹 交互 —— 无缝嵌入 Vue 组件
  • 🎙 演示者模式 —— 可以使用另一个窗口,甚至是你的手机来控制幻灯片
  • 🧮 LaTeX 支持 —— 内置了对 LaTeX 数学公示的支持
  • 📰 图表支持 —— 使用文本描述语言创建图表
  • 🌟 图标 —— 能够直接从任意图标库中获取图标
  • 💻 编辑器 —— 集成的编辑器,或者使用 VS Code 扩展
  • 🎥 录制 —— 内置录制功能和摄像头视图
  • 📤 跨平台 —— 能够导出 PDF、PNG 文件,甚至是一个可以托管的单页应用
  • ⚡️ 快速 —— 基于 Vite 的即时重载
  • 🛠 可配置 —— 支持使用 Vite 插件、Vue 组件以及任何的 npm 包

📨 与官网文档同步

目前 Slidev 中文文档翻译已全部完成。

同步原理:每天,主仓库docs 目录会被提取到本仓库的 upstream 分支。本仓库的 sync 分支会在需要时从 mainupstream 分支合并,并在完成翻译后发起 PR 到主仓库的 main 分支。

📝 参与贡献

感谢您的参与!若要修正翻译错误,请向 main 分支提交 PR;若要帮助翻译新增内容,请向 sync 分支提交 PR;若英文原版即有须有修改住处,请向主仓库提交 PR。

若需要本地预览网站效果,可执行如下命令:

# 全局安装 pnpm
$ npm i -g pnpm

# 安装依赖,使用 pnpm
$ pnpm i
# 启动文档
$ pnpm run dev

接着访问提示的网址(一般为 http://localhost:5173/)即可。

或者安装 VSCode 的 Vite 插件 快速启动开发服务器。

贡献者

感谢各位贡献者的付出(以下排名不分先后):

新版文档:

_Kerman wemsx XiaoDong 诺墨

初版文档:

Anthony Fu QiChang Li 清秋 Chuck Songhn ArcherGu
antfu QC-L Ivocin ChuanfengZhang songhn233 ArcherGu
Jacob Qiang raintygao 六个骨头 Kim Yang KnowsCount
jacob-lcs iDestin zrr1999 KimYangOfCat KnowsCount
ZhengX
Megrax