Getting Started with rabit

Build your first burrow

Overview
Getting Started
Documentation
Examples

1. Create a Manifest

Create a `.burrow.json` file in the root of your project or documentation directory.

{
  "version": "1.0",
  "title": "My Project",
  "description": "Documentation for My Project",
  "entries": [
    {
      "type": "link",
      "title": "README",
      "uri": "README.md",
      "mediaType": "text/markdown"
    },
    {
      "type": "burrow",
      "title": "API Docs",
      "uri": "api/.burrow.json"
    }
  ]
}

2. Add Content

Ensure the files referenced in `uri` exist relative to the manifest.

3. Validate

Use the `rabit` CLI (coming soon) or a JSON schema validator to check your manifest.