Skip to content

Latest commit

 

History

History
25 lines (14 loc) · 1.32 KB

File metadata and controls

25 lines (14 loc) · 1.32 KB

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.

Local Development

This documentation was created from Nextra.

First, run pnpm i to install the dependencies.

Then, run pnpm dev to start the development server and visit localhost:3000.

To use a different port, run pnpm next dev -p <port_number>.

Deployment & hosting

This site is hosted on Vercel, and updated automatically when the main branch is updated.

Important

Make sure to add new file's reference in the _meta.json file of the respective directory to make it appear in the sidebar and for the search to work properly. This also help merge-docs.py script to merge the docs properly.