Liquid Documentation

Docs

Doc	Directory	Sidebar
LFM	lfm	sidebarsLfm.ts
LEAP	leap	sidebarsLeap.ts
Examples	examples	sidebarsExamples.ts

Local Development

npm install
npm run dev

The local server will be available at http://localhost:3000.

To test the build:

npm run build
npm run serve

The npm run serve script does not support hot loading.

Search

Search is enabled by Algolia:

• Algolia crawler runs regularly on certain days within a week configured in the crawler.
• It also runs periodically through the algolia-index.yaml GitHub action, when there are changes in the production branch.

Link check

There are two link checks in this repo:

• Docusaurus will throw error for any broken as configured by onBrokenLinks in docusaurus.config.ts. If the broken build is annoying for preview, change it to warn.
• The check.yaml workflow has a check-link job that examine markdown links. Customize the config in link-check.json. If a link cannot be accessed (e.g. Github private repo), add the URL pattern to the ignorePatterns array.

Deployment

The deployment is automated through Vercel.

Branch	Domain
main	https://docs-staging.liquid.ai/
production	https://docs.liquid.ai/

To promote the main branch to production, run the deploy-main.yaml GitHub action, which will automatically fast-forward the production branch to match main.

LICENSE

Attribution-ShareAlike 4.0 International