File Coverage

blib/lib/Statocles.pm
Criterion Covered Total %
statement 4 4 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 6 6 100.0


line stmt bran cond sub pod time code
1             package Statocles;
2             our $VERSION = '0.086';
3             # ABSTRACT: A static site generator
4              
5             # The currently-running site.
6             # I hate this, but I know of no better way to ensure that we always have access
7             # to a Mojo::Log object, while still being relatively useful, without having to
8             # wire up every single object with a log object.
9             our $SITE;
10              
11             BEGIN {
12             package # Hide from PAUSE
13             site;
14 2428     2428   46827 sub log { return $SITE->log }
15             }
16              
17 68     68   28491006 use Statocles::Base;
  68         187  
  68         631  
18              
19              
20             1;
21              
22             __END__
23              
24             =pod
25              
26             =encoding UTF-8
27              
28             =head1 NAME
29              
30             Statocles - A static site generator
31              
32             =head1 VERSION
33              
34             version 0.086
35              
36             =head1 SYNOPSIS
37              
38             # Create a new site
39             statocles create www.example.com
40              
41             # Create a new blog post
42             export EDITOR=vim
43             statocles blog post
44              
45             # Build the site
46             statocles build
47              
48             # Test the site in a local web browser
49             statocles daemon
50              
51             # Deploy the site
52             statocles deploy
53              
54             =head1 DESCRIPTION
55              
56             Statocles is an application for building static web pages from a set of plain
57             YAML and Markdown files. It is designed to make it as simple as possible to
58             develop rich web content using basic text-based tools.
59              
60             =head2 FEATURES
61              
62             =over
63              
64             =item *
65              
66             A simple format based on
67             L<Markdown|http://daringfireball.net/projects/markdown/> for editing site
68             content.
69              
70             =item *
71              
72             A command-line application for building, deploying, and editing the site.
73              
74             =item *
75              
76             A simple daemon to display a test site before it goes live.
77              
78             =item *
79              
80             A L<blogging application|Statocles::App::Blog#FEATURES> with
81              
82             =over
83              
84             =item *
85              
86             RSS and Atom syndication feeds.
87              
88             =item *
89              
90             Tags to organize blog posts. Tags have their own custom feeds.
91              
92             =item *
93              
94             Crosspost links to direct users to a syndicated blog.
95              
96             =item *
97              
98             Post-dated blog posts to appear automatically when the date is passed.
99              
100             =back
101              
102             =item *
103              
104             Customizable L<themes|Statocles::Theme> using L<the Mojolicious template
105             language|Mojo::Template#SYNTAX>.
106              
107             =item *
108              
109             A clean default theme using L<the Skeleton CSS library|http://getskeleton.com>.
110              
111             =item *
112              
113             SEO-friendly features such as L<sitemaps (sitemap.xml)|http://www.sitemaps.org>.
114              
115             =item *
116              
117             L<Automatic checking for broken links|Statocles::Plugin::LinkCheck>.
118              
119             =item *
120              
121             L<Syntax highlighting|Statocles::Plugin::Highlight> for code and configuration blocks.
122              
123             =item *
124              
125             Hooks to add L<your own plugins|Statocles::Plugin> and L<your own custom
126             applications|Statocles::App>.
127              
128             =back
129              
130             =head1 GETTING STARTED
131              
132             To get started with Statocles, L<consult the Statocles::Help guides|Statocles::Help>.
133              
134             =head1 SEE ALSO
135              
136             For news and documentation, L<visit the Statocles website at
137             http://preaction.me/statocles|http://preaction.me/statocles>.
138              
139             =head1 AUTHOR
140              
141             Doug Bell <preaction@cpan.org>
142              
143             =head1 CONTRIBUTORS
144              
145             =for stopwords djerius Ferenc Erki Joel Berger Kent Fredric Konrad Bucheli perlancar (@netbook-zenbook-ux305) tadegenban Vladimir Lettiev William Lindley
146              
147             =over 4
148              
149             =item *
150              
151             djerius <djerius@cfa.harvard.edu>
152              
153             =item *
154              
155             Ferenc Erki <erkiferenc@gmail.com>
156              
157             =item *
158              
159             Joel Berger <joel.a.berger@gmail.com>
160              
161             =item *
162              
163             Kent Fredric <kentnl@cpan.org>
164              
165             =item *
166              
167             Konrad Bucheli <kb@open.ch>
168              
169             =item *
170              
171             perlancar (@netbook-zenbook-ux305) <perlancar@gmail.com>
172              
173             =item *
174              
175             tadegenban <tadegenban@gmail.com>
176              
177             =item *
178              
179             Vladimir Lettiev <thecrux@gmail.com>
180              
181             =item *
182              
183             William Lindley <wlindley@wlindley.com>
184              
185             =back
186              
187             =head1 COPYRIGHT AND LICENSE
188              
189             This software is copyright (c) 2016 by Doug Bell.
190              
191             This is free software; you can redistribute it and/or modify it under
192             the same terms as the Perl 5 programming language system itself.
193              
194             =cut