Welcome to the repo for the VolarJS documentation! This repo contains the source code we use to build our site (and of course, its content)
For more information on what Volar itself is, check out the main repository, or the website itself.
Contributions of all size are welcome! If you find a typo, or want to clarify some language, or even want to add a whole new section, no matter what, we're happy to welcome your contributions.
If you can see what the problem is, and you know how to fix it, then definitely feel free to make a PR (pull request) with the needed changes and contribute to this repo yourself. Alternatively, opening an issue and letting us know about the problem is also a totally valid option.
If you want to run the docs locally, you can do so by following these steps:
-
Clone the repo:
git clone https://github.com/volarjs/docs -
Install dependencies:
pnpm install -
Run the site locally:
pnpm run dev -
Open the site in your browser: http://localhost:4321
You can now open up the project in your favorite editor and start making changes. To make changes to the content, edit files in the src/content directory.
