Skip to content

dictybase-docker/developer-docs

Repository files navigation

dictyBase developer documentation

GitHub action Maintainability
Last commit
Funding

Static site to display all deployment documentation for dictyBase software. Built using Gatsby.

Development

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.

Adding New Pages

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.

Adding Navbar Links

Add a link name and route to the menuLinks array in gatsby-config.js. This config will generate navbar links automatically.

Styling

It is preferred to use Material-UI for any styling. See examples of the useStyles hook in the layout.tsx file.

Misc badges

Issues Open Issues Closed Issues
Total PRS Open PRS Closed PRS Merged PRS
Commits Branches Tags
GitHub repo size GitHub code size in bytes Lines of Code

About

Gatsby static site for displaying developer documentation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published