docs-v8 icon indicating copy to clipboard operation
docs-v8 copied to clipboard

Contribute to Docs at new location:

Don't use this repo; instead can modify docs here:

NativeScript Logo


Running the docs locally

git clone https://github.com/NativeScript/docs-new.git
npm i
npm start

Important Note about Plugin Docs

Plugin docs are automatically synced every night via cron job with various plugin workspace repos, for example:

  • https://github.com/NativeScript/firebase
  • https://github.com/NativeScript/plugins
  • https://github.com/NativeScript/payments
  • https://github.com/NativeScript/ui-kit

Each plugin workspace can manage it's own set of README's for documentation. This docs repo will keep itself in sync with them every night. If you want to modify any plugin documentation, you can do so via their plugin workspaces as listed above.

Outline

  • Introduction
    • How to use the docs
    • Prerequisites
    • Learn the basics
    • Templates
    • Versioning Scheme
  • Environment Setup
    • Setting up your system
    • Integrating with native apps
    • Building for Other Platforms/Devices
      • Building for Smart Watches
  • Development Workflow
    • Running on virtual device
    • Running on physical device
    • HMR
    • Debugging
    • Testing
    • Using packages
    • Updating
  • UI & Styling
    • Layouts
    • Components
    • CSS
  • Native API Access
  • Interaction
    • Gestures
    • Navigation
    • Animations
    • Accessibility
  • Networking
  • Connectivity
  • Performance
    • Profiling
    • Scroll Performance
    • Navigation Performance
  • Advanced Concepts
    • Marshalling
    • Multithreading & Workers
    • Metadata filtering
  • Releasing your app
  • Developing Plugins
  • Common Pitfalls