NativeScript-Vue website

This is the source for the nativescript-vue.org website.

Contributions are welcome, all the content is placed in the content directory.

Setup

Clone this repo to your local machine and install the dependencies.

cd nativescript-vue.org/
npm install

Start documentation

We use VitePress for rapid development and documenting. You can start it locally by

npm run dev

Now, you can open the URL generated in your browser to see the generated docs.

Build documentation

Run the HTTP server using the already generated dist/ directory:

npm run build
npm run preview

Good practices

Check broken links

If you've modified a large portion of the documentation or added/modified links, it's a good idea to ensure that all the documentation links still work. To do this, you can run the command linkinator, which will return a report of the links that can't be resolved.

npm run build
npm run check-links