Static site to display all deployment documentation for dictyBase software. Built using Gatsby.
Run gatsby develop
to start the developmental server.
Do any work in a new branch then open a pull request to merge into develop
when
completed. Any pushes to develop
will generate a new Gatsby build and deploy to
our static site. See the
corresponding GitHub workflow.
To add pages to existing categories, just add a markdown file to that directory and a new page will be with
slugs that match the filename (i.e. /deployment/admin.md
will create a page at /deployment/admin/
).
created on the fly. Remember to add the required header so that the page is displayed.
When creating a new category (i.e. deployment
), create a new directory under src/pages
. Copy in the
index.tsx file and change the Layout category
prop and add
whatever default content you want to display.
Add a link name and route to the menuLinks
array in gatsby-config.js. This
config will generate navbar links automatically.
It is preferred to use Material-UI for any styling. See examples of the useStyles
hook in the
layout.tsx file.