NativeScript Docs

NativeScript Docs uses Antora as documentation generator.

Theme derived from official Lisk documentation.

Click here to see the live version of the NativeScript Documentation.

How to contribute to the NativeScript Documentation

Overview

Content

The Content of the whole NativeScript documentation is stored in main branch for now:

main

Documentation for previous versions of the NativeScript is stored in branches following the naming convention:

docs-sdk-VERSION

where VERSION is always referring to the corresponding software version.

UI

The presentation of the documentation is stored near the actual content in ui/ directory. But will later move to a separate location form the actual content. It will be stored on the antora branch.

Building

The build branch stores the local-preview-site.yml file, which is used to generate the NativeScript Documentation using Antora for local preview.

Please, change the local-preview-site.yml file to set up paths to the content and the UI.

To build and preview the documentation, run npx antora local-preview-site.yml in the build directory.

Although the site is viewable without a web server, you may still need to view your site through a web server to test certain features, such as indexed URLs, caching, or scripts that don’t work over the file: protocol. You can use the http-server package for this purpose. http-server is a simple, static web server for Node.js.

Install the http-server package globally using npm:

demo-site $ npm i -g http-server` or Yarn:

demo-site $ yarn global add http-server

Now launch the web server by pointing it at the location of the generated site. In the terminal, type the command name, http-server, followed by the location of the generated site (i.e., the output dir). We also recommend adding the -c-1 flag to disable caching.

demo-site $ http-server build/site -c-1

Upon launching the command, the local address of the web server will be displayed in your terminal.