Skip to content


Repository files navigation

Scarf Docs

Join the Scarf Community Slack

This repo serves Scarf's documentation site located at

The site uses MkDocs to generate the doc site from markdown.

Running locally


# Setup
pip install -r requirements.txt
# Serve
mkdocs serve
# drop into a shell with dependencies installed
devenv shell

# run the dev server
devenv up


GitHub Actions are configured for this repository to deploy changes on every update to the master branch.


Join the Scarf-Community workspace on Slack to learn more about our products and plans. We'll keep an eye out for your questions and concerns. And if you have issues that aren't covered in Scarf Docs, we'd love to hear from you.