https://github.com/memowe/dirdown
Minimal file-system based CMS
https://github.com/memowe/dirdown
cms file-system markdown minimal perl static-site-generator
Last synced: about 1 year ago
JSON representation
Minimal file-system based CMS
- Host: GitHub
- URL: https://github.com/memowe/dirdown
- Owner: memowe
- License: mit
- Created: 2019-02-22T17:58:38.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-04-08T11:43:27.000Z (about 7 years ago)
- Last Synced: 2025-02-16T14:57:17.318Z (over 1 year ago)
- Topics: cms, file-system, markdown, minimal, perl, static-site-generator
- Language: Perl
- Homepage:
- Size: 96.7 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Dirdown
=======
Minimal file-system based CMS
[](https://travis-ci.org/memowe/dirdown)
## Generate a new dirdown web application
1. Invoke the generator
```bash
$ mojo generate dirdown_app
```
2. Edit the markdown content in `dirdown_content`.
3. Start the server via
```bash
$ morbo dirdown
Server available at http://127.0.0.1:3000
```
4. Dump the content as static files via
```bash
$ ./dirdown dump
```
## Use it as a plugin for your own Mojolicious web apps:
```perl
#!/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][perl]**
| Module | Version |
|-------------------------------------------|-----------|
| [Mojolicious][mojo] | 8.12 |
| [Text::Markdown][tmd] | 1.000031 |
| [YAML::XS][yml] | 0.76 |
| *[Test::Exception][teex] (Tests only)* | *0.43* |
[perl]: https://www.perl.org/get.html
[mojo]: https://metacpan.org/pod/Mojolicious
[tmd]: https://metacpan.org/pod/Text::Markdown
[yml]: https://metacpan.org/pod/YAML::XS
[teex]: https://metacpan.org/pod/Test::Exception
License and copyright
---------------------
Copyright (c) 2019 [Mirko Westermeier][mirko] ([\@memowe][mgh], [mirko@westermeier.de][mmail])
Released under the MIT (X11) license. See [LICENSE.txt][mit] for details.
[mirko]: http://mirko.westermeier.de
[mgh]: https://github.com/memowe
[mmail]: mailto:mirko@westermeier.de
[mit]: LICENSE.txt