Webpan Documentation
Table of contents

What is Webpan?

Webpan is a blank-canvas take on the static site generator: a blank-canvas software is a skeleton program that can be easily extended by installing plugins. This ensures there are no hard-coded behaviours - that all features are customisable.

What can Webpan do?

Use case Status
Documentation ✅ YES! We have plugins - this page is generated with Webpan!
Notes publishing ✅ YES! Use the same plugins for documentation, which supports unlimited folder depth.
Blog site ⏳ WIP! I am writing plugins for that.

Things that are unique to Webpan

  • Renders everything into HTML and CSS, so JavaScript is not required to display LaTeX\LaTeX or Mermaid diagrams.

    maindevelop0-4612f1c1-e32acb62-3b5ad433-692f5574-23b7f245-4f013116-fe93fc78-e0e1d179-173716e

  • Ability to use multiple plugins at once to maximise chaos.

    /blob-postswhy-im-really-cool.mddemonstrating-my-coolness.htmldemonstrating-my-coolness.cssdemonstrating-my-coolness.jsnotesrust-lang.mddiscrete-maths.texdigital-electronics.typ

    There are currently no plugins supporting .tex or .typ files, but file format cross-play is entirely doable.

Developer Experience

  • Incremental building - remembers the previous build, and only rebuild what's changed.
  • Instant preview - with edits typically reflected in <1000ms without refreshing the page.
  • Reproducible build - all plugins are installed as npm packages on the project.

Human-made notice

Webpan is human-made, any programming sins committed is my fault alone.