Documentation

The documentation website is built using Docusaurus, a static website generator. See the hosted documentation at josxha.github.io/flutter-maplibre

Run locally

To run the website locally, you need to have Node.js and yarn installed. You can Node.js from here and install yarn by running npm install -g yarn.

Run the following commands to fetch the dependencies:

yarn

Then, run the following command to start the development server:

yarn start

This command starts a local development server. Most changes are reflected live without having to restart the server.

Create new docs version

To create a new version of the documentation, run the following command:

yarn docusaurus docs:version <version>

A new versioned_docs.version-<version> folder will be created and the version gets added to the versions.json file.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

The website is deployed automatically to GitHub Pages via CI.