Skip to content

Latest commit

 

History

407 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Knowledge docs for agents. Git-native MDX. Publish on merge.

Demo

Read the docs

Install

npm install -g edda-docs

Quickstart

# Sign in with GitHub in your browser, once
edda login

# Scaffold a docs site into ./docs
edda new docs --template starter

# Preview it at localhost:3030, reloading as you edit
edda dev

# Deploy
edda push docs

Your site is live on its own blode.md subdomain, taking its name, navigation, and theme from the docs.json that edda new writes.

Commands

Command Description
edda login Authenticate with GitHub in your browser, no API key to manage
edda new [dir] Scaffold a docs site, --template minimal or starter
edda dev Serve the docs locally and reload on save
edda validate Check docs.json before you deploy
edda push [dir] Deploy a docs directory to its project
edda projects List the projects on your account
edda analytics Manage PostHog: get, set posthog <key>, unset posthog

Agent skill

Install the slash command for Claude Code or any skills.sh-compatible agent:

npx skills add mblode/edda -g --all -y

Then scaffold and deploy in plain language:

/edda new my-project --template starter
/edda push docs/ --project my-project

Environment and exit codes

Variable Purpose
EDDA_API_KEY / BLODEMD_API_KEY API key. Used ahead of a stored login session, so CI needs no edda login.
EDDA_PROJECT / BLODEMD_PROJECT Default value for --project.
EDDA_API_URL / BLODEMD_API_URL API origin. Defaults to the hosted API.

Every command exits with one of these, so a CI gate can branch on the number:

Code Meaning
0 Success
1 Error
2 Cancelled, including a declined prompt
3 Invalid input or config
4 Authentication required
5 Network failure

With --json, a failure is data too: the command writes one line to stdout shaped {"error":true,"code":"AUTH_REQUIRED","message":"...","hint":"..."}. Branch on code, which is stable, rather than on message, which is written for a human.

Notes

  • Node.js 24.
  • push, validate, and projects take --json, and push reads EDDA_PROJECT / BLODEMD_PROJECT, EDDA_API_KEY / BLODEMD_API_KEY, and EDDA_BRANCH / BLODEMD_BRANCH from the environment, so CI can deploy without an interactive login.
  • Install the GitHub App from your project's dashboard to deploy automatically on every push to a branch.

License

MIT


Crafted by Matthew Blode

About

Knowledge docs for agents. Git-native MDX. Publish on merge.

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages