Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Purlo docs

Public developer documentation for the Purlo image API, published to https://docs.purlo.dev via GitHub Pages (MkDocs Material).

Source of truth

The Markdown in docs/ is synced from the private goodliff/purlo repo's docs/ folder — that repo is where the docs are authored and kept in step with the code. Only the public pages live there (internal ops runbooks are in that repo's internal-docs/, never here). Edit the docs in goodliff/purlo and re-run the sync; treat this repo's docs/ as generated.

Local preview

pip install mkdocs-material
mkdocs serve   # http://127.0.0.1:8000

Deploy

Pushing to main runs .github/workflows/deploy.yml, which builds the site and publishes it to GitHub Pages. The custom domain is set by docs/CNAME.

About

Public developer docs for the Purlo image API (docs.purlo.dev). Synced from goodliff/purlo.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors