mirror of
https://github.com/tauri-apps/tauri-docs.git
synced 2026-01-31 00:35:16 +01:00
bf723f1c29268e644eaeae5ebbf64eb2462293bb
Tauri Docs
This website is built using Docusaurus 2, a modern static website generator.
You can check the state of a PR by looking at the Deploy preview that Netlify builds and is mentioned in its bot's comment.
Installation
$ yarn
Local Development
$ yarn start
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
Build
$ yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
Deployment
$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.
License
MIT License
Copyright (c) 2020 Tauri Team
Languages
MDX
94.9%
Astro
2.2%
TypeScript
1.9%
JavaScript
0.6%
SCSS
0.2%
Other
0.2%