Skip to content

wazo-platform/wazo-platform.org

Repository files navigation

Wazo Platform Website

This repo contains the source and building scripts for generating https://wazo-platform.org/.

Content Change

The content is authored using the Markdown language in the content directory. The build process is done using Gatsby.

Installation

Build the builder container:

make builder
cp config.sample.js config.js  # the config.js file must exist

In config.js, you can configure the Algolia credentials used for the search engine. If left empty, the search engine will be disabled.

Develop

make ENV=CORPORATE=1 develop

Then open http://localhost:8000 in your favorite browser.

styling

There is a top-level .prettierrc file for the prettier formatter.

For uc-doc Markdown documents, the command yarn format:uc-doc should be used (and will be checked by CI).

Building

make ENV=CORPORATE=1 build

The documentation is built in the public/ folder, you can then run a simple HTTP server:

cd public/
python3 -m http.server

Then open http://localhost:8000 in your favorite browser.

Testing

make test