https://github.com/cxw42/unbelievable

The power of Dancer2 in a static site generator! Yes, yet another SSG --- can you believe it?
https://github.com/cxw42/unbelievable

perl perl5 static-site-generator wip

Last synced: about 2 months ago
JSON representation

The power of Dancer2 in a static site generator! Yes, yet another SSG --- can you believe it?

• Host: GitHub
• URL: https://github.com/cxw42/unbelievable
• Owner: cxw42
• License: other
• Created: 2020-01-26T05:08:35.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-02-23T21:01:52.000Z (almost 5 years ago)
• Last Synced: 2024-04-18T12:11:35.596Z (9 months ago)
• Topics: perl, perl5, static-site-generator, wip
• Language: Perl
• Homepage: https://metacpan.org/pod/App::unbelievable
• Size: 123 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: Changes
  • License: LICENSE

Awesome Lists containing this project

README

        
# NAME

App::unbelievable - Dancer2 static site generator

# SYNOPSIS

In your Dancer2 app:

    use App::unbelievable;  # Pulls in Dancer2

    # your routes here

    unbelievable;           # At EOF, fills in the rest of the routes.

Then:

    $ unbelievable build    # Make the HTML

    $ unbelievable serve    # Run a local development server

App::unbelievable makes a Dancer2 application into a static site generator.

App::unbelievable adds routes for `/` and `/**` that will render Markdown

files in `content/`.  The [unbelievable](https://metacpan.org/pod/unbelievable) script generates static HTML

and other assets into `_built/`.

# FEATURES

## Markdown rendering

All non-hidden files in `content/` are rendered as Markdown files.

Hidden files are those that start with a `.` (the Unix convention).

## Fenced code blocks

Fenced code blocks are syntax-highlighted using

[Syntax::Highlight::Engine::Kate](https://metacpan.org/pod/Syntax::Highlight::Engine::Kate).  Language names are the lowercased

versions of the module suffixes in

[Syntax::Highlight::Engine::Kate::All](https://metacpan.org/source/MANWAR/Syntax-Highlight-Engine-Kate-0.14/lib/Syntax/Highlight/Engine/Kate/All.pm).

## Shortcodes

In Markdown inputs, shortcode tags of the form:

    {{< KEY [args] >}}

are replaced with the Dancer2 template `shortcodes/KEY` (e.g.,

`views/shortcodes/foo.tt`).  Arguments are passed to the template as array

`_`.  Each individual argument is also passed to the template as variable

`_n`, `n`=0, 1, ... .

Each argument can be a sequence of non-space characters (e.g., `foo`), or

a quoted string.  Quoted strings can be delimited by `'` or `"`, and can

include embedded quotes escaped using a backslash (e.g., `'cxw\'s SSG'`).

## Templates

Use whatever you want in your routes!  Use regular Dancer2 templating.

## Static files

Everything in `public/` is available under `/`, just as in Dancer2.

# WHY?

Yet another site generator --- can you believe it?  And now you know where

the package name comes from ;) .

This package's roadmap is feature parity with [Hugo](https://gohugo.io/).

My motivation for writing unbelievable was two-fold:

1. Perl.com is currently using Hugo, which is not written in Perl!

2. "every self-respecting programmer has written at least one static site

generator ... since writing a basic one is easy and often tends to be easier

than learning an existing one." --- SHLOMIF

([here](http://web-cpan.shlomifish.org/latemp/)).  :D

# FUNCTIONS

## import

Imports [Dancer2](https://metacpan.org/pod/Dancer2), among others, into the caller's namespace.

## unbelievable

Make default routes to render Markdown files in `content/` into HTML.

Usage: `unbelievable;`.  Returns a truthy value, so can be used as the

last line in a module.

# THANKS

- Thanks to [Getopt::Long::Subcommand](https://metacpan.org/pod/Getopt::Long::Subcommand) and [Syntax::Highlight::Engine::Kate](https://metacpan.org/pod/Syntax::Highlight::Engine::Kate) ---

I used some code from the perldoc of those modules.

- Thanks to [App::Wallflower](https://metacpan.org/pod/App::Wallflower), [Dancer2](https://metacpan.org/pod/Dancer2), and

[Syntax::Highlight::Engine::Kate](https://metacpan.org/pod/Syntax::Highlight::Engine::Kate) for doing the heavy lifting!

# LICENSE

Copyright (C) 2020 Chris White.

This library is free software; you can redistribute it and/or modify

it under the same terms as Perl itself.

# AUTHOR

Chris White