Skip to content

Latest commit

 

History

History
77 lines (52 loc) · 3.21 KB

README.md

File metadata and controls

77 lines (52 loc) · 3.21 KB

fdm-monster-docs

The documentation for FDM Monster 3D Printing server based on Docusaurus

Contributors ✨

These are the people involved in the project. Find the meaning of the emoji keys here.

All Contributors

David Zwart
David Zwart

🐛 💻 🚧 📓
Maurice Kevenaar
Maurice Kevenaar

🚧 🤔 📖 🐛
Gijs Groote
Gijs Groote

🐛

Docs Website

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

yarn start --no-open

This command starts a local development server without opening a browser window. You can open the website using http://localhost:3000

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.