Skip to content
blode.md

Documentation that ships with your code

Write docs in your editor, version them in git, and deploy from the command line. No separate system, no manual steps

Three commands to deploy

No dashboard. No CMS. Login, create, push. The same workflow you use for code works for docs

# authenticate once

$ blodemd login

# scaffold from your project root

$ blodemd new docs

# ship it

$ blodemd push docs

Deployed to acme.blode.md

Everything in one project

Write once, in MDX. blode.md handles the rest

  • MDX components Callouts, tabs, code groups, API references, and 30+ built-in components
  • Custom domains Automatic DNS verification and SSL provisioning
  • Search Full-text search across all your content, included by default
  • Content types Docs, blogs, changelogs, and courses from one project
  • API reference Interactive docs generated from your OpenAPI spec
  • Versioning Pin docs to releases so readers can pick their version

Deploy docs on every merge

Add one step to your GitHub Actions workflow and docs deploy alongside your code

- name: Deploy docs
  run: npx blodemd push docs
  env:
    BLODEMD_API_KEY: ${{ secrets.BLODEMD_API_KEY }}

Get started in a minute

$ npm install -g blodemd