Contributing
Thank you for your interest in contributing to NativeScript-Vue!
Development
Follow these steps to start contributing to the NativeScript-Vue codebase:
Setup
Clone the repository to your local environment:
git clone https://github.com/nativescript-vue/nativescript-vue.git
Install all necessary dependencies using Yarn:
yarn install
Navigate to the demo application:
cd demo
Launch the application in debug mode for your chosen platform (iOS or Android):
ns debug ios|android
You can now modify the NativeScript-Vue source code located in the src
directory. Changes made here will automatically reflect in the demo application.
Documentation
We warmly welcome contributions to enhance the NativeScript-Vue documentation.
Setup
Fork the official documentation repository nativescript-vue.org, clone your fork locally, and install the required dependencies:
git clone https://github.com/<your-username>/nativescript-vue.org.git
cd nativescript-vue.org/
npm install
Running the documentation locally
We utilize VitePress for rapid documentation development. Start the local development server with:
npm run dev
Open the URL provided in your terminal in your web browser to preview your changes live.
Building the documentation
Build and preview the static documentation site locally with the following commands:
npm run build
npm run preview
Best practices
Checking for broken links
After making extensive changes or modifying any links, it's recommended to verify all documentation links remain functional. Use Linkinator to generate a report highlighting any broken links:
npm run build
npm run check-links