anserwaseem / ensemble_docs

Ensemble documentation

Ensemble Documentation

This repo contains Ensemble docs hosted at docs.ensembleui.com.

Contributing to the docs directly on GitHub

Because Ensemble docs are created directly from the markdown in this repo, you can use the GitHub web editor to edit and propose changes to the docs directly from your browser without any knowledge of git. To do that, find the markdown file with the docs you want to edit and follow GitHub's instructions to edit and propose changes to a markdown file. Once approved, the docs will be updated immediately.

Contributing to the docs by forking this repo

1. Fork and clone this repo.
2. Install docsify: sudo npm install -g docsify-cli
3. Startup the local docsify server with docsify serve . from the root of this repo.
4. Edit the markdown and verify your changes on the localhost url outputted from the docsify serve command.
5. Put up a pull request to this repo

Other Ensemble repos and links

• Ensemble Runtime - use this repo to report issues and feature requests for Ensemble's core runtime library
• Ensemble Starter - Ensemble Starter project enables you to run Ensemble-powered Apps and generate release builds across iOS, Android, Web, and desktop.
• Roadmap