simplicii/docs

Documentation, API reference, and code snippets for NativeScript

NativeScript Documentation

Home of the NativeScript documentation content that lives at http://docs.nativescript.org. Start contributing today!

• Contributing 🍺
• Branches ⤴️
• Configuration ⚙️
• Tutorials 📖
• Contributors ❤️

Contributing

The NativeScript documentation is completely open source and we love contributions. Whether you want to fix a typo, or write an entire article, the NativeScript documentation is a great way to get started contributing to an open source project.

Don’t know where to start? Check out the list of issues with the “up-for-grabs” label. New to git or GitHub? Join our community Slack chat and we’ll be happy to help get you up and running.

Branches

This repository’s two main branches are master and production.

• The production branch contains the version of the content that is currently deployed on docs.nativescript.org. New commits to this branch trigger a complete build that will push the changes live; therefore, only commit urgent fixes to this branch.
• The master branch contains the most up-to-date version of the NativeScript documentation. The contents of the master branch are moved into the production branch with NativeScript release; therefore, the master branch is perfect for updating the docs about yet-to-be-released versions of NativeScript, as well as trivial changes that don’t need to be deployed immediately.

When in doubt feel free to submit pull requests against either branch.

Note: The pull request should be made in production branch, in case those edits are related to the current version of NativeScript and it is important to immediately publish the changes(e.g. mistakes in the code snippets, semantic errors in the articles, etc.)

All other pull requests related to the upcoming releases or when it is not critical for the current version, should be made in the master branch (e.g. article for a new feature, adding some extra information for the component or modules, etc.).

Configuration

There are two versions of the NativeScript documentation that generate similar output: nativescript and angular. The former builds the vanilla NativeScript docs at docs.nativescript.org, while the latter discusses Angular-specific topics at docs.nativescript.org/angular.

Most of the content in this repository is shared between the two environments, but occasionally you may need to add environment-specific content. When you have this need you have a few options.

1. If you would like a page to appear in a single environment, add an environment: angular or environment: nativescript property to that page's front matter. Pages marked with an environment property will appear in a single environment, and pages not marked with an environment property will be shared across all environments.

2. If you have a page that should be appear in both environments but has different content for certain sections, you can use our built-in environment block tags. The blocks are named angular and nativescript, respectively, and can be used like this:

{% nativescript %}This paragraph appears only in the vanilla NativeScript documentation{% endnativescript %}

This paragraph appears in both environments.

{% angular %}This appears only in the Angular NativeScript documentation{% endangular %}

Tutorials

The NativeScript documentation contains two full getting started tutorials, one for using NativeScript with vanilla JavaScript, and another for using NativeScript with Angular. The contents of these two tutorials are in this repository’s /tutorial folder.

When making changes to either of these tutorials you might need to additional alter one of the four templates these tutorials use. Readers use these templates through the tns create command, for example tns create HelloWorld --template nativescript-template-tutorial.

• JavaScript
  • nativescript-template-tutorial
    • Hello world template used by the JavaScript tutorial.
  • nativescript-template-groceries
    • Starting point for the Groceries example used by the JavaScript tutorial.
• Angular
  • nativescript-template-ng-tutorial
    • Hello world template used by the Angular tutorial.
  • nativescript-template-ng-groceries
    • Starting point for the Groceries example used by the Angular tutorial.

Contributors

The following is a list of all the people that have contributed to the NativeScript documentation. Thanks for your contributions!