Leahnaya/pretendo-docker
1
0
Fork 0
mirror of https://github.com/MatthewL246/pretendo-docker.git synced 2026-05-06 05:27:35 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity
0618254bc4
pretendo-docker/docs
History
Matthew Lopez 0618254bc4
Configure docs-only mode and delete other pages
2024-05-25 14:24:05 -04:00
..
docs Create Docusaurus docs site from template 2024-05-25 14:24:01 -04:00
src/css Configure docs-only mode and delete other pages 2024-05-25 14:24:05 -04:00
static Configure docs-only mode and delete other pages 2024-05-25 14:24:05 -04:00
.gitignore Create Docusaurus docs site from template 2024-05-25 14:24:01 -04:00
babel.config.js Create Docusaurus docs site from template 2024-05-25 14:24:01 -04:00
docusaurus.config.ts Configure docs-only mode and delete other pages 2024-05-25 14:24:05 -04:00
package-lock.json Create Docusaurus docs site from template 2024-05-25 14:24:01 -04:00
package.json Create Docusaurus docs site from template 2024-05-25 14:24:01 -04:00
README.md Create Docusaurus docs site from template 2024-05-25 14:24:01 -04:00
sidebars.ts Configure docs-only mode and delete other pages 2024-05-25 14:24:05 -04:00
tsconfig.json Create Docusaurus docs site from template 2024-05-25 14:24:01 -04:00

README.md

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.