Excited to hear that you are interested in contributing to this project! Thanks!
Documentations are now moved to slidevjs/docs
repo.
You can contribute through a development environment in your browser by clicking the following button:
This project uses pnpm
to manage the dependencies, install it if you haven't via
npm i -g pnpm
Clone this repo to your local machine and install the dependencies.
pnpm install
To build all the packages at once, run the following command on the project root
pnpm build
Build with watch mode
pnpm dev
To run Slidev locally, you can run
pnpm demo:dev
Or with the real-world example Composable Vue
:
pnpm demo:composable-vue
The server will restart automatically every time the builds get updated.
We use monorepo to manage multiple packages
packages
slidev/ - main package entry, holds the code on Node.js side
client/ - main frontend app
parser/ - parser for Slidev's extended Markdown format
create-app/ - scripts and template for `npm init slidev`
create-theme/ - scripts and template for `npm init slidev-theme`
theme-*/ - official themes
Don't worry about the code style as long as you install the dev dependencies. Git hooks will format and fix them for you on committing.
Thank you again for being interested in this project! You are awesome!