Wing Documentation Website

This repository hosts the documentation website for Wing (docs.winglang.io).

Development Environment

It is built using Docusaurus 2, a modern and awesome static website generator.

$ npm install

Copy the .env.example to .env:

$ cp .env.example .env

And fill it with the proper values. Then:

$ npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

$ npm run build

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

We have an automated crawler (by Algolia) every day at 15:00 UTC that indexes the documentation website.

Every merge to the main branch triggers a new crawler indexing.

If for some reason there is a need to trigger the crawler manually, follow these steps:

update the local .env file with the proper values (see in 1Password "Algolia Crawler").
run the following command:

npm run reindex

This repository is licensed under the MIT License.