10000 GitHub - 2252/docs: WordLift Documentation
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

2252/docs

 
 

Repository files navigation

Website

This website is built using Docusaurus 2, 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.

Build

$ yarn build

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

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

How to regenerate the API docs

npm run docusaurus clean-api-docs analysis && npm run docusaurus gen-api-docs analysis npm run docusaurus clean-api-docs events && npm run docusaurus gen-api-docs events npm run docusaurus clean-api-docs manager && npm run docusaurus gen-api-docs manager

About

WordLift Documentation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 86.8%
  • TypeScript 7.4%
  • Shell 5.2%
  • CSS 0.6%
0