README.md

webpan is currently under development. Join the webpan development channel (Matrix) for updates and support.

Overview

webpan is an extensible build tool that can be used for:

• Static site generation, such as creating wiki and blog sites.
• Publishing massive, loosely structured notes folders.
• Or any other user defined conversion tasks.

Design philosophy

Be extensible

There are a billion file formats out there, by default webpan supports zero - it is up to the user to decide what they want.

Be declarative

Options are done centrally through a central config file, so any new files created will look correct without tweaks.

Be portable

A webpan project is entriely self-contained, so it can be synced through Git and still look the same everywhere.

Usage

Requires: npm and any text editor.

1. Create a new webpan project.

   $ npm create wproject

   This creates a new folder at my-wproject/.
2. CD into the project folder, and install the project dependencies.

   $ npm install

3. Build the project, webpan reads from the src/ folder and writes output to the dist/ folder.

   $ npm run build

4. View the files with a web browser. Or if you have python installed, start an http server with

   $ python -m http.server

The webpan universe

Your webpan project is made of:

• webpan: the extensible build tool.

• create-wproject: the webpan project template.

• webpan packages: they look at the src/ folder and writes to the dist/ folder. In src/wrules.json, you can see copy and index being used in the template project.

  You can create your own package, or install existing packages with

  $ npm install wp-<package-name>

Todo List

As the project is very new, these are the things I am working on:

• wp-unified package which adds unified support. Which in turns support conversion between a huge collection of file formats.
• A vitepress clone for writing docs (and then write the webpan docs with it).