Skip to content

webhookdb/docs

Repository files navigation

WebhookDB docs

The docs use the Jekyll Just the Docs theme. It has extensive documentation on customization and other details.

Also refer to the Jekyll Docs for information about how to structure content, what goes into frontmatter, etc.

Local development

Run make run-local to build and run a docker container to serve the Jekyll site locally (this avoids you having to deal with Ruby). You will need to restart it in certain cases, like modifying the config file, but the build will watch for changes and you'll see them when you reload your browser.

Deployment

Deployment is handled via Github Actions and deploys to Github Pages.

View the docs at docs.webhookdb.com.