HOW WE THINK ABOUT THE WEB

Tools should make publishing feel clear.

These principles are a direction for design and development. They give contributors a way to weigh tradeoffs as the project evolves.

1. 01

   No magic

   Build steps and outcomes should be understandable. A command should do what it says, and errors should help you decide what to do next.

2. 02

   A useful starting point

   Defaults should help you begin with little configuration. When you need more control, the relevant settings should be easy to find.

3. 03

   Content comes first

   Writing, organizing and publishing content should remain the center of the workflow. Markdown and templates keep that work close to your files.

4. 04

   Stability matters

   Changes should consider existing sites. When a breaking change is necessary, provide a clear migration path and explain the reason.

5. 05

   Room to extend

   Keep common tasks approachable while allowing additional functionality through documented extension points.

PUT THE PRINCIPLES TO WORK

Build with us.

See how the project is organized and propose a change with context.

Contribute ↗