File Coverage

blib/lib/auto/share/dist/Statocles/create/site.yml
Criterion Covered Total %
statement 105 105 100.0
branch n/a
condition n/a
subroutine 35 35 100.0
pod n/a
total 140 140 100.0


line stmt bran cond sub pod time code
1 1     1   1613  
  1     1   2  
  1     1   7  
  1     1   103  
  1     1   3  
  1     1   39  
  1     1   5  
  1     1   2  
  1     1   17  
  1     1   4  
  1     1   2  
  1     1   19  
  1     1   4  
  1     1   2  
  1     1   466  
  1     1   1447  
  1     1   2  
  1     1   9  
  1     1   108  
  1     1   2  
  1     1   84  
  1     1   7  
  1     1   2  
  1     1   17  
  1     1   5  
  1     1   2  
  1     1   20  
  1     1   4  
  1     1   3  
  1     1   454  
  1     1   1386  
  1     1   2  
  1     1   8  
  1     1   113  
  1     1   2  
  1         53  
  1         5  
  1         2  
  1         17  
  1         3  
  1         2  
  1         28  
  1         5  
  1         2  
  1         436  
  1         1331  
  1         3  
  1         7  
  1         107  
  1         3  
  1         55  
  1         6  
  1         2  
  1         17  
  1         3  
  1         3  
  1         23  
  1         4  
  1         2  
  1         442  
  1         1324  
  1         2  
  1         7  
  1         106  
  1         2  
  1         81  
  1         6  
  1         2  
  1         17  
  1         4  
  1         3  
  1         20  
  1         4  
  1         2  
  1         456  
  1         1793  
  1         5  
  1         13  
  1         136  
  1         3  
  1         63  
  1         8  
  1         5  
  1         19  
  1         8  
  1         4  
  1         22  
  1         6  
  1         4  
  1         469  
  1         1605  
  1         4  
  1         17  
  1         147  
  1         5  
  1         82  
  1         14  
  1         9  
  1         31  
  1         7  
  1         5  
  1         28  
  1         6  
  1         4  
  1         472  
2             ### Generated by Statocles version <%= $Statocles::VERSION %>
3              
4             # This is the site configuration file. The format is YAML, and the config is
5             # read by Beam::Wire, a dependency-injection library that builds complete
6             # objects. For full details on how to edit this file, see
7             # Statocles::Help::Config.
8             #
9             # This file contains configuration for objects. Each object has a name, like
10             # "site", "theme", or "blog_app". This name can be used to refer to the object
11             # later, for example, using "$ref: name".
12             #
13             # Every object has a "class". Developers can customize behavior by changing the
14             # class or creating their own classes. If you need help with an object, look at
15             # the class's documentation.
16             #
17             # Every object has "args", which are the object's attributes. See the class's
18             # documentation for a full list of attributes and what they do.
19             #
20             # Many objects have events. Event handlers can be configured using the "on"
21             # key. See the class's documentation for a list of possible events. Every
22             # event handler should have at least "$class" and a "$sub". "$class" is the
23             # plugin class. "$sub" is the plugin method to run. If necessary, you can
24             # add "$args" to configure the plugin object.
25              
26             # site: This is the main site object. Site objects handle building and
27             # deploying, and store global site data like themes and navigation. See
28             # Statocles::Site for a full list of attributes and what they do.
29             site:
30             class: 'Statocles::Site'
31              
32             args:
33              
34             # title: This is the title of the site, shown in the <title> tag
35             title: 'My Statocles Site'
36              
37             # base_url: This is the base URL the site will be deployed to. It
38             # should be a full URL, and may contain a path, like:
39             #
40             # http://example.com/username
41             #
42             # If the base_url contains a path, all internal links will be
43             # rewritten appropriately.
44             base_url: '<%= $site->{base_url} %>'
45              
46             # apps: These are the applications in this site. The name of the app,
47             # "blog", "page", or "static", is used to refer to it in commands.
48             apps:
49              
50             # blog: This is the blog app
51             blog:
52             $ref: 'blog_app'
53              
54             # page: This app turns any Markdown page into HTML
55             page:
56             $ref: 'page_app'
57              
58             # static: This app does no processing at all. Good for images
59             static:
60             $ref: 'static_app'
61              
62             # plugins: These are plugins that can add features and alter the
63             # content of the site.
64             plugins:
65             link_check:
66             $class: 'Statocles::Plugin::LinkCheck'
67              
68             # theme: The theme builds and manages the templates. Use themes to
69             # change how your site looks.
70             theme:
71             $ref: 'theme'
72              
73             # index: The path to the page that should be used for the site index.
74             index: '<%= $site->{index} %>'
75              
76             # nav: These are lists of navigation links used by the theme.
77             # Navigations are used to move between applications, or to go to
78             # specific, important pages.
79             #
80             # The "main" nav is the primary navigation for the site. Every theme
81             # should have this one.
82             #
83             # Each nav consists of an array of links. See the Statocles::Link class
84             # for a list of attributes and what they mean. The most important are
85             # "text", the text of the link, and "href", the URL to link to.
86             nav:
87             main:
88             % for my $link ( @{ $site->{nav}{main} // [] } ) {
89             - text: '<%= $link->{text} %>'
90             href: '<%= $link->{href} %>'
91             % }
92              
93             # deploy: This is the deploy object, used to deploy this site.
94             deploy:
95             $ref: 'deploy'
96              
97             # theme: These are the settings for the theme. See Statocles::Help::Theme for
98             # more information, and Statocles::Theme for a full list of attributes and what
99             # they do
100             theme:
101             class: 'Statocles::Theme'
102             args:
103             # store: The store points to the directory where the theme's
104             # templates are kept. Under-the-hood, this is a Statocles::Store
105             # object.
106             #
107             # Themes have a special syntax to refer to themes that come bundled with
108             # Statocles. See Statocles::Help::Theme for more information
109             store: '<%= $theme->{args}{store} %>'
110              
111             # deploy: These are the settings for the site's deploy. See Statocles::Deploy::File
112             # for a full list of attributes and what they do.
113             deploy:
114             class: '<%= $deploy->{class} %>'
115             args:
116             % for my $k ( keys %{ $deploy->{args} } ) {
117             <%= $k %>: '<%= $deploy->{args}{$k} %>'
118             % }
119              
120             #----------------------------------------------------------------------------
121             # Applications
122             #----------------------------------------------------------------------------
123             #
124             # All applications have a "url_root" attribute, which is the root URL of the
125             # app. All the app's pages will be under this URL.
126             #
127             # Most applications have a "store" attribute. The store points to the directory
128             # where the application's data is kept. Under-the-hood, this is a
129             # Statocles::Store object, but you only need to specify the directory path.
130              
131             # blog_app: These are the settings for the blog application.
132             blog_app:
133             class: 'Statocles::App::Blog'
134             args:
135             url_root: '/blog'
136             store: 'blog'
137              
138             # page_app: These are the settings for the page application.
139             page_app:
140             class: 'Statocles::App::Basic'
141             args:
142             store: 'page'
143             url_root: '/page'
144              
145             # static_app: These are the settings for the static application.
146             static_app:
147             class: 'Statocles::App::Basic'
148             args:
149             store: 'static'
150             url_root: '/static'