cromedome / Waltz

Prototyping tool and static website builder, like the lovechild of Hugo and Middleman.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Waltz

If Hugo and Middleman had a lovechild, Waltz would be it. Build a static blog ala Hugo, or do some bona fide mockups like Middleman. Eventually, you can bootstrap this into a full Dancer2 app. But we aren't there yet. You're lucky there is even this. You're welcome.

Building and Installing

Eventually, when this gets built for release, there will be a fatpacked version to make it easy to copy around where needed. If installed from CPAN and there are XS components available, this will use those XS components.

Note: If we eventually switch to Xslate for templating, fatpacking stops being an option. In that case, make it easy for people to install CPAN dependencies.

Running Waltz

If you were to serve static content out of the repo's share/ directory, you'd want to do the following:

PERL5LIB=../lib DANCER_CONFDIR=. DANCER_VIEWS=views/ ../bin/waltz dev

That's not a great real world example however. I will provide a better one when I have a bona fide test repository based on Hugo content ready to server.

Roadmap

This is highly subject to change:

  • Add site configuration to templates
  • When running the server, generate static content from markdown files.
  • When content changes, regenerate files that have been changed.
  • Tests
  • Metadata validation from the CLI
  • Generate category, tag, recent pages from generate
  • Typesense or Algolia (preferred) search
  • Widgets:
    • Categories, tags, Recent Entries widgets
    • Widget to show all posts, all for category, all for tag
    • Basic analytics components
    • Disqus widget
    • Social sharing widget
  • Marketing site
  • Release 1.0
  • Profit! (not)

After 1.0:

  • Pagination
  • RSS
  • Themes
  • Hugo migration tool
  • CLI search tool
  • Consider Xslate migration
  • App bootstrapping

About

Prototyping tool and static website builder, like the lovechild of Hugo and Middleman.


Languages

Language:Perl 66.9%Language:CSS 27.4%Language:HTML 5.7%