Getting Started
Install Project Broadsheet, deploy a first version, and publish your first article.
Install Project Broadsheet
Download the source, install its dependencies, and start a local preview server. The entire process takes 3–5 minutes on a modern machine.
Deploy your first version
Move the built site from your laptop to a public URL using Cloudflare Pages. HTTPS and a custom domain are included at no charge.
Local development
Run Project Broadsheet on your own machine with automatic browser reload. Covers the dev server, editing workflow, and the differences between development and production builds.
After your first deploy
Your site is live. Here are the ten things to do before you publish your first article.
Project structure
A map of every folder in a Project Broadsheet repository and what lives inside it. Skim this once and the rest of the documentation will read much more easily.
Using Project Broadsheet without the terminal
Two paths to a live publication for writers, journalists, and educators who prefer not to use the command line.
Upgrade Project Broadsheet
How to pull upstream improvements into your publication without overwriting your customizations.
If this category should cover a topic that isn't here yet, send us feedback.