0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2024-12-16 20:26:19 -05:00
logto/packages/docs
2022-04-22 10:02:54 +00:00
..
docs docs: update LogtoClient clientId -> appId (#621) 2022-04-22 09:24:27 +00:00
i18n/zh-cn/docusaurus-plugin-content-docs docs: update LogtoClient clientId -> appId (#621) 2022-04-22 09:24:27 +00:00
src docs: add Swift Logto core reference (#573) 2022-04-19 11:31:27 +08:00
static docs: update config for deployment (#575) 2022-04-19 14:12:46 +08:00
.gitignore feat: init docs (#503) 2022-04-07 09:45:01 +08:00
babel.config.js feat: init docs (#503) 2022-04-07 09:45:01 +08:00
docusaurus.config.js docs: update config for deployment (#575) 2022-04-19 14:12:46 +08:00
package.json chore: add package script (#607) 2022-04-22 10:02:54 +00:00
README.md feat: init docs (#503) 2022-04-07 09:45:01 +08:00
sidebars.js docs: add Swift Logto core reference (#573) 2022-04-19 11:31:27 +08:00
tsconfig.json feat: init docs (#503) 2022-04-07 09:45:01 +08:00

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.