Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 1.3 KB

README.md

File metadata and controls

38 lines (29 loc) · 1.3 KB

Website

This website is built using Docusaurus, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn 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.

Deployment

When your changes are ready to be reviewed, push the changes to your fork or to a feature branch and then open a pull request on GitHub. After review, when your changes get merged, they will get deployed to https://lf-lang.org/ using GitHub Actions.

In our deployment workflow, we simply run:

$ yarn build

This generates static content in the build directory, which gets served using GitHub's static contents hosting service, GitHub Pages.

Versioning

Instructions for "freezing" the current docs and filing them under a version number, can be found here. Normally, the steps are:

git switch main
git pull
git checkout -b v<major>.<minor>.<patch>
yarn docusaurus docs:version <major>.<minor>.<patch>
git add versioned_docs/*
git add versioned_sidebars/*
git commit -a -m 'Docs v<major>.<minor>.<patch>'