This repo contains the materials needed to edit and publish the public documentation for Buchla products. It uses the Docusaurus site generator to generate a static website from markdown documents. The documentation is viewable on the GitHub Pages site.
- Best done with Atom, really.
- A nice Word converter is found here
Documentation for getting started with Docusaurus is at their website. Here's some specific instructions.
You'll need NodeJS and npm installed on your computer. There's several ways to do this. Here's a few options. You can also follow this recipe to use node version manager (nvm) which is the more future-proof way of installing NodeJS.
Clone this repo, then run a command to install the nodeJS packages
Run the command
npm install
Then:
npm run start
will build the docs and launch a server. It should open your browser to the local site http://localhost:3000/.
If you clone this repo and push some changes, you'll need to publish or deploy the site to git hub pages.
Use the Docusaurus guide to learn how to deploy to GitHub Pages. You'll need to setup SSH access for github, as that's the best way to securely publish from the Terminal.
Then, you simply use the command
USE_SSH=true yarn deploy
Here's a nice tool for setting up the colors in CSS.