Ionic Docs

This is the home for the v4+ Ionic Framework docs.

Installation

The API Docs use nodegit. This required libgcrypt to be installed, which is not installed by default in OSX as of Sierra.

On OSX Siera or later Before running any of the API scripts, first install libgrypt using Homebrew with brew install libgcrypt before running npm install. Nodegit is installed as an optional dependency and will silenty fail installing if libgcrypt is not installed.

Editors

The site content is built from markdown files in src/docs-content. Markdown files created there will automatically be turned in to routes based on their relative place in the directory.

Contributing

Ensure you're using recent versions of npm 5 and node 8.

Then run npm install, and then npm run dev to launch the site in development mode.

.