Repository for breadboard.yale.edu.
The docs are generated with VuePress. npm start will launch a dev server with live reloading for the breadboard documentation. API docs are generated from the breadboard source code.
The rest of the site is just plain html, css and js files and can be edited directly.
vuedoc is used to generate documentation for the Vue components used by Breadboard. typedoc is used for the core TypeScript files used by the Breadboard client. Both of these processes result in Markdown files that are fed into VuePress as part of the site generation process.
First add a .env file with BREADBOARD_SOURCE and DOC_ROOT environment variables defined. Use the .env.example for more information. Make desired changes in the breadboard source code and then use sh generate.sh to update the generated parts of these docs.
Use npx vuepress check-md docs to check for link issues in the documentation.
The breadboard.yale.edu website is currently hosted via the Netlify platform. It is a static website which uses Netlify functions to handle sending an email in response to a contact form.
See Netlify Forms and Netlify Functions for more information.
Netlify has support for testing their features locally via the Netlify CLI.
Before testing run npm i -g netlify-cli to install the command-line tool globally.
To simulate the Netlify build process and start a dev server run netlify dev
To simulate a form submission to our server run netlify functions:invoke send-contact-email --no-identity --payload "{\"email\": \"[email protected]\", \"name\": \"Test user 1\", \"message\": \"Hello, World!\", \"phone\": \"123456789\"}"
Note: The dev server needs to be running and your .env file needs to be complete for the form submission to work