php/docs
CloudyyUw bd5d55fbbc
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
Updating api endpoints docs for twineo
2024-03-19 21:38:26 -03:00
..
docs/Twineo Updating api endpoints docs for twineo 2024-03-19 21:38:26 -03:00
src Using docusaurus for docs 2024-03-13 23:52:29 -03:00
static Using docusaurus for docs 2024-03-13 23:52:29 -03:00
.gitignore Using docusaurus for docs 2024-03-13 23:52:29 -03:00
babel.config.js Using docusaurus for docs 2024-03-13 23:52:29 -03:00
bun.lockb Using docusaurus for docs 2024-03-13 23:52:29 -03:00
docusaurus.config.js Added docs for API Endpoints 2024-03-14 23:17:44 -03:00
package.json Using docusaurus for docs 2024-03-13 23:52:29 -03:00
README.md Using docusaurus for docs 2024-03-13 23:52:29 -03:00
sidebars.js Using docusaurus for docs 2024-03-13 23:52:29 -03:00

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.

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.