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! There are plugins - this page is generated with Webpan!
Notes publishing ✅ YES! Use the same plugins as documentation, which supports unlimited folder depth.
Blog site ⏳ WIP! I am writing plugins for that.
  • Renders everything into HTML and CSS, so JavaScript is not required to display LaTeX\LaTeX, Mermaid diagrams and syntax highlighting.

    maindevelop0-5ff4a241-75f241d2-03be8d03-1c720724-7d7d8a65-3d55fa06-c650ce88-c6bf0aa9-0d17f48
    console.log("syntax highlighting without client side JS");
    
  • 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

  • Quick subsequent builds - remembers the previous build, and only rebuild what's changed.
  • Instant preview - edits reflected in browser without refreshing the page.
  • Reproducible builds - all plugins are installed as npm packages on the project.

Human-made notice

Webpan is human-made, the experience of human programmers are prioritised.