memowe / dirdown

Minimal file-system based CMS

Dirdown

Minimal file-system based CMS

Generate a new dirdown web application

1. Invoke the generator

   $ mojo generate dirdown_app

2. Edit the markdown content in dirdown_content.
3. Start the server via

   $ morbo dirdown
   Server available at http://127.0.0.1:3000

4. Dump the content as static files via

   $ ./dirdown dump

Use it as a plugin for your own Mojolicious web apps:

#!/usr/bin/env perl
use Mojolicious::Lite;

# Load the dirdown CMS under /content
plugin Dirdown => {
    prefix  => '/content',
    dir     => app->home->rel_file('dirdown_content'),
};

get '/' => {text => 'Hello world!'};

app->start;

Prerequisites

• Perl 5.20

Module	Version
Mojolicious	8.12
Text::Markdown	1.000031
YAML::XS	0.76
Test::Exception (Tests only)	0.43

License and copyright

Copyright (c) 2019 Mirko Westermeier (@memowe, [email protected])

Released under the MIT (X11) license. See LICENSE.txt for details.

dirdown's Issues

Navigation links with .html extension should handle directories correctly

Tree and stack navigation

We need two data structures prepared for different types of navigation menus in templates:

• A tree structure
• A stack structure (first level, second level, etc)

These data structures should have a general version (site map) and a specific version for a given path. For a specific path there should be only the relevant data in it and we need something like active => 1 for nodes in the given path.

Operate as a plugin only

Now, after some web app development, it shouldn't be a web app on its own, to make things easier. The routes should be set up in the plugin.

Refresh the content tree

As the content tree is stored as lazy evaluated attributes, it also won't change when content changes.

Create a helper method to clear the cache, probably via dirdown->tree(undef).

Path with spaces?

There seems to be a problem with spaces in paths

Relative URLs don't work correctly when Dirdown works with a prefix

Use relative links in dump'ed static HTML

Generate static websites

./dirdown dump

Creates a dump directory with the same content, but in static files.

Generator script

Invoke the generate dirdown command:

• generates a web app dirdown, that uses Dirdown as a plugin
• inflates the Dirdown web app templates