spot is like blot but on rails. Spot turns a folder into a static website. It can convert docx, md, pynb, txt, latex, rtf, and really any other format supported by pandoc into html. It's suitable for a blog, docsite, or whatever you want. It only generates the html for your site, you still have to host it.
spot is a perpetual prototype. I won't write unit tests or give support. Pull requests to add your own features are encouraged, I'm happy to merge in contributions!
- Go to the latest GitHub release, and download the binary for your platform.
- Create a project folder (
mkdir my_new_project; cd my_new_project
) - Create spot scaffolding with
spot init --dir ./
- Build the project with
spot build --config ./config.yaml
- Start adding content to
./content
, update templates in./templates
, and add static files to./static
. Update theconfig.yaml
as needed. - While you're iterating, use the watch & serve feature (and turn on debug logging) with
spot --debug build --config ./config.yaml --watch --addr :8080
- The
./dist
folder contains your built static website. You can publish it's contents however you want.