Skip to content
Converse

Writing Documentation

Contributions to the documentation are much appreciated.

What is used to write the documentation?

Section titled “What is used to write the documentation?”

This documentation is written using Starlight, an Astro-based documentation generator.

The documentation source files are written in Markdown.

Where is the documentation?

Section titled “Where is the documentation?”

The Markdown documentation files are located in the converse.js code repository under docs/.

How to generate HTML from the source files?

Section titled “How to generate HTML from the source files?”

Install the dependencies

Section titled “Install the dependencies”
cd docs
npm install

Run the development server

Section titled “Run the development server”
npm run dev

This will start a local server with live-reloading. You can view the docs at http://localhost:4321.

Build for production

Section titled “Build for production”
npm run build

The HTML files will be generated in docs/dist/.

Thank you to our sponsors

If you'd like to sponsor this project, please visit Github, Patreon, Liberapay or contact us.