Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 8220d3e

Browse files
committed
[documentation] add page
1 parent d7d6509 commit 8220d3e

File tree

2 files changed

+56
-24
lines changed

2 files changed

+56
-24
lines changed

docs/plugins/blog.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Blog
22
====
33

44
Features
5-
~~~~~~~~
5+
--------
66

77
- Expose a ``blog.post`` node handler
88

docs/plugins/page.rst

Lines changed: 55 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,70 @@
1-
.. note::
2-
3-
This documentation is under construction, more to come soon
4-
5-
6-
71
Page
82
====
93

104
Features
11-
~~~~~~~~
5+
--------
6+
7+
- Expose a ``page.default`` node handler
128

13-
- Insert here the different feature available for this plugin
149

1510
Configuration
16-
~~~~~~~~~~~~~
11+
-------------
12+
13+
There is no configuration option. You only need to enable the plugin by adding this line into the IoC configuration file.
1714

18-
- Insert the yaml configuration for the DI
15+
.. code-block:: yaml
16+
17+
element.plugins.page:
18+
19+
Usage
20+
-----
21+
22+
A page node is very similar to a blog node, however it should be used to render simple page.
1923

2024
.. code-block:: yaml
2125
22-
element.plugins.cache:
23-
cache_control:
24-
- { "path": "^.*\\.(txt|jpg|png|gif|xls|doc|docx)$", "Cache-Control": ['public', 's-maxage=14212800']}
25-
- { "path": "^(blog|gallery).*", "Cache-Control": ['public', 's-maxage=3600']}
26-
- { "path": "^.*\\.rss", "Cache-Control": ['public', 's-maxage=3600']}
27-
- { "path": "^contact.*", "Cache-Control": ['private', 'must-revalidate']}
28-
- { "path": "^/$", "Cache-Control": ['public', 's-maxage=3600']}
26+
title: Homepage
27+
type: page.default
28+
format: html
29+
content: |
30+
31+
<div class="row demo-tiles">
32+
<div class="span3">
33+
<div class="tile">
34+
<img class="tile-image big-illustration" alt="" src="images/illustrations/colors.png" />
35+
<h3 class="tile-title">Blog</h3>
36+
<p>Some posts about <br/>technicals playground.</p>
37+
<a class="btn btn-primary btn-large btn-block" href="blog">Read It</a>
38+
</div>
39+
</div>
40+
41+
<div class="span3">
42+
<div class="tile">
43+
<img class="tile-image" alt="" src="images/illustrations/infinity.png" />
44+
<h3 class="tile-title">Element</h3>
45+
<p>A python CMS based on flask with a bit of IOC. </p>
46+
<a class="btn btn-primary btn-large btn-block" href="https://github.com/rande/python-element">Play</a>
47+
</div>
48+
</div>
2949

30-
Events
31-
~~~~~~
50+
<div class="span3">
51+
<div class="tile">
52+
<img class="tile-image" alt="" src="images/illustrations/bag.png" />
53+
<h3 class="tile-title">Stats</h3>
54+
<p>Some information about this instance.</p>
55+
<a class="btn btn-primary btn-large btn-block" href="stats/parameters">Get Them</a>
56+
</div>
57+
</div>
3258

33-
- List event or entry points for this plugin
59+
<div class="span3">
60+
<div class="tile">
61+
<img class="tile-image" alt="" src="images/illustrations/compass.png" />
62+
<h3 class="tile-title">Resume</h3>
63+
<p>A "standard" <br />curriculum vitae.</p>
64+
<a class="btn btn-primary btn-large btn-block" href="resume">Discover It</a>
65+
</div>
3466

35-
Architecture
36-
~~~~~~~~~~~~
67+
</div>
68+
</div>
3769

38-
- Provide information about how the feature is implemented
70+
The ``format`` option defines how to handle the ``content`` field. You can provide a markdown content or a html content.

0 commit comments

Comments
 (0)