h3n3/cadhub
1
0
Fork 0
Code Issues 35 Pull Requests Packages Projects Releases Wiki Activity

Update read me to reflect openscad and cadquery changes

Browse Source 
Resolves #336.
This commit is contained in:
Kurt Hutten
2021-06-04 18:18:53 +10:00
parent a2327b6169
commit 77d0fcb336
3 changed files with 21 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/README.md
View File

@@ -1,6 +1,8 @@
# Website
# CadHub Docs
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
Our docs are built using [Docusaurus 2](https://v2.docusaurus.io/).
The docs also contains a blog, if you have a good idea for a blog post that's Code-CAD relate, please pitch it to us.
## Installation
@@ -15,6 +17,9 @@ yarn start
```
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
Note there is a [bug](https://github.com/facebook/docusaurus/issues/4588) in the ideal-image plugin that means images are blurry in dev with a huge margin below each one. annoyingly enough the Github issue has been label as a feature not a bug.
To see the images properly in dev run `yarn build && yarn serve` instead, you'll have to run this each change.
## Build
@@ -24,10 +29,4 @@ yarn build
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Deployment
```console
GIT_USER=<Your GitHub username> USE_SSH=true 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.