https://github.com/fdm-monster/fdm-monster-docs
The documentation for FDM Monster 3D Printing server based on Docusaurus
https://github.com/fdm-monster/fdm-monster-docs
3d-printing documentation docusaurus fdm fdm-monster github-pages
Last synced: over 1 year ago
JSON representation
The documentation for FDM Monster 3D Printing server based on Docusaurus
- Host: GitHub
- URL: https://github.com/fdm-monster/fdm-monster-docs
- Owner: fdm-monster
- License: mit
- Created: 2023-10-07T16:15:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T11:45:43.000Z (about 2 years ago)
- Last Synced: 2024-05-22T12:44:42.820Z (about 2 years ago)
- Topics: 3d-printing, documentation, docusaurus, fdm, fdm-monster, github-pages
- Language: TypeScript
- Homepage: https://docs.fdm-monster.net/
- Size: 9.13 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://allcontributors.org/docs/en/emoji-key).
[](#contributors-)
David Zwart
🐛 💻 🚧 📓
Maurice Kevenaar
🚧 🤔 📖 🐛
Gijs Groote
🐛
## Docs Website
This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.
### Installation
```bash
yarn
```
### Local Development
```bash
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.
```bash
yarn start --no-open
```
This command starts a local development server without opening a browser window. You can open the website using
### Build
```bash
yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
Using SSH:
```bash
USE_SSH=true yarn deploy
```
Not using SSH:
```bash
GIT_USER= 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.