18 | {{this.body}}
19 |
20 | {% endblock %}
21 | {{item.title}}
25 |{{item.abstract}}
26 | {% endfor %} 27 |
14 | {% if caption %}
15 |
6 |
7 |
7 |
8 |
9 |
22 |
23 | {% include 'footer.html' %}
24 |
25 |
10 | {% for item in this.content %}
11 |
20 |
21 |
12 |
14 | {{item.date|dateformat}} {{item.title}}
13 |
15 | {{item.body}}
16 |
17 |
18 | {% endfor %}
19 | 17 |
8 |
15 |
16 | {% endblock %}
17 |
18 |
9 |
14 |
10 |
13 | {{this.title}}
11 |{{this.abstract}}
12 |
19 |
32 |
33 | {% endblock %}
34 |
--------------------------------------------------------------------------------
/doc/_layouts/home.html:
--------------------------------------------------------------------------------
1 | {% extends "_base.html" %}
2 |
3 | {% block home %}
4 | {% endblock %}
5 |
6 | {% block body %}
7 |
8 |
20 |
21 |
31 |
22 |
23 | {% for item in this.content %}
24 |
28 |
29 |
30 |
9 |
18 |
19 |
10 |
17 |
11 |
16 |
12 |
15 | {{this.title}}
13 |{{this.tagline}}
14 |
20 |
21 | {% set news = site.reflinks['/news'].content[0] %}
22 |
25 |
26 |
27 | {% include 'footer.html' %}
28 |
29 | {% endblock %}
30 |
--------------------------------------------------------------------------------
/doc/news/2015-11-22.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: "Urubu 0.8 released"
3 | layout: page
4 | date: 2015-11-22
5 | ---
6 |
7 | Release highlights:
8 |
9 | * the `urubu` serve command automatically takes
10 | the `baseurl` option into account (Pull request #27).
11 |
12 | * when an undefined anchor is referred to in a page, a
13 | warning is generated, just like for references to undefined pages (Issue #30).
14 |
15 | * the `layout` attribute can be assigned `null`. In this
16 | way the page content can be used by other pages, but no html is generated for
17 | the page itself.
18 |
19 | In addition, a significant effort was put into development robustness. In
20 | particular, a regression test suite has been added. This is based on `py.test`
21 | and `tox`, so that both Python 2.7 and 3.4 are verified.
22 |
23 |
24 |
--------------------------------------------------------------------------------
/urubu/__main__.py:
--------------------------------------------------------------------------------
1 | # Copyright 2014 Jan Decaluwe
2 | #
3 | # This file is part of Urubu.
4 | #
5 | # Urubu is free software: you can redistribute it and/or modify
6 | # it under the terms of the GNU Affero General Public License as published by
7 | # the Free Software Foundation, either version 3 of the License, or
8 | # (at your option) any later version.
9 | #
10 | # Urubu is distributed in the hope that it will be useful,
11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | # GNU Affero General Public License for more details.
14 | #
15 | # You should have received a copy of the GNU Affero General Public License
16 | # along with Urubu. If not, see {{news.date|dateformat}}: {{news.title}}
23 | {{this.body}} 24 |
6 |
7 |
53 |
54 | {% endblock %}
55 |
56 |
--------------------------------------------------------------------------------
/urubu/tests/ambig_ref/_layouts/page.html:
--------------------------------------------------------------------------------
1 | {% extends "_base.html" %}
2 |
3 | {% block body %}
4 |
5 |
8 | {% block title %}
9 |
12 |
13 | {{this.title}}
10 | {% endblock %} 11 |
14 |
15 |
39 |
40 | {% if this.pager %}
41 |
16 | {% block content %}
17 |
22 |
23 | {% block sidebar %}
24 | {% if this.toc %}
25 |
26 |
34 |
35 | {% endif %}
36 | {% endblock %}
37 |
38 | -
42 | {% if this.prev %}
43 |
- ← {{this.prev.title}} 44 | {% endif %} 45 | {% if this.next %} 46 |
- {{this.next.title}} → 47 | {% endif %} 48 |
6 |
7 |
53 |
54 | {% endblock %}
55 |
56 |
--------------------------------------------------------------------------------
/urubu/tests/ambig_ref_md/_layouts/page.html:
--------------------------------------------------------------------------------
1 | {% extends "_base.html" %}
2 |
3 | {% block body %}
4 |
5 |
8 | {% block title %}
9 |
12 |
13 | {{this.title}}
10 | {% endblock %} 11 |
14 |
15 |
39 |
40 | {% if this.pager %}
41 |
16 | {% block content %}
17 |
22 |
23 | {% block sidebar %}
24 | {% if this.toc %}
25 |
18 | {{this.body}}
19 |
20 | {% endblock %}
21 |
26 |
34 |
35 | {% endif %}
36 | {% endblock %}
37 |
38 | -
42 | {% if this.prev %}
43 |
- ← {{this.prev.title}} 44 | {% endif %} 45 | {% if this.next %} 46 |
- {{this.next.title}} → 47 | {% endif %} 48 |
6 |
7 |
53 |
54 | {% endblock %}
55 |
56 |
--------------------------------------------------------------------------------
/urubu/tests/ambig_refid/_layouts/page.html:
--------------------------------------------------------------------------------
1 | {% extends "_base.html" %}
2 |
3 | {% block body %}
4 |
5 |
8 | {% block title %}
9 |
12 |
13 | {{this.title}}
10 | {% endblock %} 11 |
14 |
15 |
39 |
40 | {% if this.pager %}
41 |
16 | {% block content %}
17 |
22 |
23 | {% block sidebar %}
24 | {% if this.toc %}
25 |
18 | {{this.body}}
19 |
20 | {% endblock %}
21 |
26 |
34 |
35 | {% endif %}
36 | {% endblock %}
37 |
38 | -
42 | {% if this.prev %}
43 |
- ← {{this.prev.title}} 44 | {% endif %} 45 | {% if this.next %} 46 |
- {{this.next.title}} → 47 | {% endif %} 48 |
6 |
7 |
53 |
54 | {% endblock %}
55 |
56 |
--------------------------------------------------------------------------------
/urubu/tests/date_format/_layouts/page.html:
--------------------------------------------------------------------------------
1 | {% extends "_base.html" %}
2 |
3 | {% block body %}
4 |
5 |
8 | {% block title %}
9 |
12 |
13 | {{this.title}}
10 | {% endblock %} 11 |
14 |
15 |
39 |
40 | {% if this.pager %}
41 |
16 | {% block content %}
17 |
22 |
23 | {% block sidebar %}
24 | {% if this.toc %}
25 |
18 | {{this.body}}
19 |
20 | {% endblock %}
21 |
26 |
34 |
35 | {% endif %}
36 | {% endblock %}
37 |
38 | -
42 | {% if this.prev %}
43 |
- ← {{this.prev.title}} 44 | {% endif %} 45 | {% if this.next %} 46 |
- {{this.next.title}} → 47 | {% endif %} 48 |
6 |
7 |
53 |
54 | {% endblock %}
55 |
56 |
--------------------------------------------------------------------------------
/urubu/tests/no_yamlfm/_layouts/page.html:
--------------------------------------------------------------------------------
1 | {% extends "_base.html" %}
2 |
3 | {% block body %}
4 |
5 |
8 | {% block title %}
9 |
12 |
13 | {{this.title}}
10 | {% endblock %} 11 |
14 |
15 |
39 |
40 | {% if this.pager %}
41 |
16 | {% block content %}
17 |
22 |
23 | {% block sidebar %}
24 | {% if this.toc %}
25 |
18 | {{this.body}}
19 |
20 | {% endblock %}
21 |
26 |
34 |
35 | {% endif %}
36 | {% endblock %}
37 |
38 | -
42 | {% if this.prev %}
43 |
- ← {{this.prev.title}} 44 | {% endif %} 45 | {% if this.next %} 46 |
- {{this.next.title}} → 47 | {% endif %} 48 |
6 |
7 |
53 |
54 | {% endblock %}
55 |
56 |
--------------------------------------------------------------------------------
/urubu/tests/undef_anchor/_layouts/page.html:
--------------------------------------------------------------------------------
1 | {% extends "_base.html" %}
2 |
3 | {% block body %}
4 |
5 |
8 | {% block title %}
9 |
12 |
13 | {{this.title}}
10 | {% endblock %} 11 |
14 |
15 |
39 |
40 | {% if this.pager %}
41 |
16 | {% block content %}
17 |
22 |
23 | {% block sidebar %}
24 | {% if this.toc %}
25 |
18 | {{this.body}}
19 |
20 | {% endblock %}
21 |
26 |
34 |
35 | {% endif %}
36 | {% endblock %}
37 |
38 | -
42 | {% if this.prev %}
43 |
- ← {{this.prev.title}} 44 | {% endif %} 45 | {% if this.next %} 46 |
- {{this.next.title}} → 47 | {% endif %} 48 |
6 |
7 |
53 |
54 | {% endblock %}
55 |
56 |
--------------------------------------------------------------------------------
/urubu/tests/undef_content/_layouts/page.html:
--------------------------------------------------------------------------------
1 | {% extends "_base.html" %}
2 |
3 | {% block body %}
4 |
5 |
8 | {% block title %}
9 |
12 |
13 | {{this.title}}
10 | {% endblock %} 11 |
14 |
15 |
39 |
40 | {% if this.pager %}
41 |
16 | {% block content %}
17 |
22 |
23 | {% block sidebar %}
24 | {% if this.toc %}
25 |
18 | {{this.body}}
19 |
20 | {% endblock %}
21 |
26 |
34 |
35 | {% endif %}
36 | {% endblock %}
37 |
38 | -
42 | {% if this.prev %}
43 |
- ← {{this.prev.title}} 44 | {% endif %} 45 | {% if this.next %} 46 |
- {{this.next.title}} → 47 | {% endif %} 48 |
6 |
7 |
53 |
54 | {% endblock %}
55 |
56 |
--------------------------------------------------------------------------------
/urubu/tests/undef_key/_layouts/page.html:
--------------------------------------------------------------------------------
1 | {% extends "_base.html" %}
2 |
3 | {% block body %}
4 |
5 |
8 | {% block title %}
9 |
12 |
13 | {{this.title}}
10 | {% endblock %} 11 |
14 |
15 |
39 |
40 | {% if this.pager %}
41 |
16 | {% block content %}
17 |
22 |
23 | {% block sidebar %}
24 | {% if this.toc %}
25 |
18 | {{this.body}}
19 |
20 | {% endblock %}
21 |
26 |
34 |
35 | {% endif %}
36 | {% endblock %}
37 |
38 | -
42 | {% if this.prev %}
43 |
- ← {{this.prev.title}} 44 | {% endif %} 45 | {% if this.next %} 46 |
- {{this.next.title}} → 47 | {% endif %} 48 |
6 |
7 |
53 |
54 | {% endblock %}
55 |
56 |
--------------------------------------------------------------------------------
/urubu/tests/undef_layout/_layouts/page.html:
--------------------------------------------------------------------------------
1 | {% extends "_base.html" %}
2 |
3 | {% block body %}
4 |
5 |
8 | {% block title %}
9 |
12 |
13 | {{this.title}}
10 | {% endblock %} 11 |
14 |
15 |
39 |
40 | {% if this.pager %}
41 |
16 | {% block content %}
17 |
22 |
23 | {% block sidebar %}
24 | {% if this.toc %}
25 |
18 | {{this.body}}
19 |
20 | {% endblock %}
21 |
26 |
34 |
35 | {% endif %}
36 | {% endblock %}
37 |
38 | -
42 | {% if this.prev %}
43 |
- ← {{this.prev.title}} 44 | {% endif %} 45 | {% if this.next %} 46 |
- {{this.next.title}} → 47 | {% endif %} 48 |
6 |
7 |
53 |
54 | {% endblock %}
55 |
56 |
--------------------------------------------------------------------------------
/urubu/tests/undef_ref/_layouts/page.html:
--------------------------------------------------------------------------------
1 | {% extends "_base.html" %}
2 |
3 | {% block body %}
4 |
5 |
8 | {% block title %}
9 |
12 |
13 | {{this.title}}
10 | {% endblock %} 11 |
14 |
15 |
39 |
40 | {% if this.pager %}
41 |
16 | {% block content %}
17 |
22 |
23 | {% block sidebar %}
24 | {% if this.toc %}
25 |
18 | {{this.body}}
19 |
20 | {% endblock %}
21 |
26 |
34 |
35 | {% endif %}
36 | {% endblock %}
37 |
38 | -
42 | {% if this.prev %}
43 |
- ← {{this.prev.title}} 44 | {% endif %} 45 | {% if this.next %} 46 |
- {{this.next.title}} → 47 | {% endif %} 48 |
6 |
7 |
53 |
54 | {% endblock %}
55 |
56 |
--------------------------------------------------------------------------------
/urubu/tests/undef_ref_md/_layouts/page.html:
--------------------------------------------------------------------------------
1 | {% extends "_base.html" %}
2 |
3 | {% block body %}
4 |
5 |
8 | {% block title %}
9 |
12 |
13 | {{this.title}}
10 | {% endblock %} 11 |
14 |
15 |
39 |
40 | {% if this.pager %}
41 |
16 | {% block content %}
17 |
22 |
23 | {% block sidebar %}
24 | {% if this.toc %}
25 |
18 | {{this.body}}
19 |
20 | {% endblock %}
21 |
26 |
34 |
35 | {% endif %}
36 | {% endblock %}
37 |
38 | -
42 | {% if this.prev %}
43 |
- ← {{this.prev.title}} 44 | {% endif %} 45 | {% if this.next %} 46 |
- {{this.next.title}} → 47 | {% endif %} 48 |
6 |
7 |
53 |
54 | {% endblock %}
55 |
56 |
--------------------------------------------------------------------------------
/urubu/tests/ignore_patterns/_layouts/page.html:
--------------------------------------------------------------------------------
1 | {% extends "_base.html" %}
2 |
3 | {% block body %}
4 |
5 |
8 | {% block title %}
9 |
12 |
13 | {{this.title}}
10 | {% endblock %} 11 |
14 |
15 |
39 |
40 | {% if this.pager %}
41 |
16 | {% block content %}
17 |
22 |
23 | {% block sidebar %}
24 | {% if this.toc %}
25 |
18 | {{this.body}}
19 |
20 | {% endblock %}
21 |
26 |
34 |
35 | {% endif %}
36 | {% endblock %}
37 |
38 | -
42 | {% if this.prev %}
43 |
- ← {{this.prev.title}} 44 | {% endif %} 45 | {% if this.next %} 46 |
- {{this.next.title}} → 47 | {% endif %} 48 |
6 |
7 |
53 |
54 | {% endblock %}
55 |
56 |
--------------------------------------------------------------------------------
/urubu/tests/undef_reflink_url/_layouts/page.html:
--------------------------------------------------------------------------------
1 | {% extends "_base.html" %}
2 |
3 | {% block body %}
4 |
5 |
8 | {% block title %}
9 |
12 |
13 | {{this.title}}
10 | {% endblock %} 11 |
14 |
15 |
39 |
40 | {% if this.pager %}
41 |
16 | {% block content %}
17 |
22 |
23 | {% block sidebar %}
24 | {% if this.toc %}
25 |
18 | {{this.body}}
19 |
20 | {% endblock %}
21 |
26 |
34 |
35 | {% endif %}
36 | {% endblock %}
37 |
38 | -
42 | {% if this.prev %}
43 |
- ← {{this.prev.title}} 44 | {% endif %} 45 | {% if this.next %} 46 |
- {{this.next.title}} → 47 | {% endif %} 48 |
6 |
7 |
53 |
54 | {% endblock %}
55 |
56 |
--------------------------------------------------------------------------------
/urubu/tests/undef_tag_layout/_layouts/page.html:
--------------------------------------------------------------------------------
1 | {% extends "_base.html" %}
2 |
3 | {% block body %}
4 |
5 |
8 | {% block title %}
9 |
12 |
13 | {{this.title}}
10 | {% endblock %} 11 |
14 |
15 |
39 |
40 | {% if this.pager %}
41 |
16 | {% block content %}
17 |
22 |
23 | {% block sidebar %}
24 | {% if this.toc %}
25 |
18 | {{this.body}}
19 |
20 | {% endblock %}
21 |
26 |
34 |
35 | {% endif %}
36 | {% endblock %}
37 |
38 | -
42 | {% if this.prev %}
43 |
- ← {{this.prev.title}} 44 | {% endif %} 45 | {% if this.next %} 46 |
- {{this.next.title}} → 47 | {% endif %} 48 |
6 |
7 |
53 |
54 | {% endblock %}
55 |
56 |
--------------------------------------------------------------------------------
/urubu/tests/undef_reflink_title/_layouts/page.html:
--------------------------------------------------------------------------------
1 | {% extends "_base.html" %}
2 |
3 | {% block body %}
4 |
5 |
8 | {% block title %}
9 |
12 |
13 | {{this.title}}
10 | {% endblock %} 11 |
14 |
15 |
39 |
40 | {% if this.pager %}
41 |
16 | {% block content %}
17 |
22 |
23 | {% block sidebar %}
24 | {% if this.toc %}
25 |
18 | {{this.body}}
19 |
20 | {% endblock %}
21 |
26 |
34 |
35 | {% endif %}
36 | {% endblock %}
37 |
38 | -
42 | {% if this.prev %}
43 |
- ← {{this.prev.title}} 44 | {% endif %} 45 | {% if this.next %} 46 |
- {{this.next.title}} → 47 | {% endif %} 48 |
6 |
7 |
53 |
54 | {% endblock %}
55 |
56 |
--------------------------------------------------------------------------------
/urubu/_compat.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | """
3 | jinja2._compat
4 | ~~~~~~~~~~~~~~
5 |
6 | Some py2/py3 compatibility support based on a stripped down
7 | version of six so we don't have to depend on a specific version
8 | of it.
9 |
10 | :copyright: Copyright 2013 by the Jinja team, see AUTHORS.
11 | :license: BSD, see LICENSE for details.
12 | """
13 | import sys
14 |
15 | PY2 = sys.version_info[0] == 2
16 | PYPY = hasattr(sys, 'pypy_translation_info')
17 | _identity = lambda x: x
18 |
19 |
20 | if not PY2:
21 | unichr = chr
22 | range_type = range
23 | text_type = str
24 | string_types = (str,)
25 | integer_types = (int,)
26 |
27 | iterkeys = lambda d: iter(d.keys())
28 | itervalues = lambda d: iter(d.values())
29 | iteritems = lambda d: iter(d.items())
30 |
31 | ifilter = filter
32 | imap = map
33 | izip = zip
34 | intern = sys.intern
35 |
36 | import socketserver
37 | import http.server as httpserver
38 |
39 | else:
40 | unichr = unichr
41 | text_type = unicode
42 | range_type = xrange
43 | string_types = (str, unicode)
44 | integer_types = (int, long)
45 |
46 | iterkeys = lambda d: d.iterkeys()
47 | itervalues = lambda d: d.itervalues()
48 | iteritems = lambda d: d.iteritems()
49 |
50 | from itertools import imap, izip, ifilter
51 | intern = intern
52 |
53 | import SocketServer as socketserver
54 | import SimpleHTTPServer as httpserver
55 |
56 |
--------------------------------------------------------------------------------
/doc/more/sites.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Websites powered by Urubu
3 | layout: simple_page
4 | ---
5 |
6 | I created Urubu to solve a personal problem: how to create and maintain
7 | websites for my projects. I open-sourced it "in the hope it can be useful". On
8 | this page I list a number of websites that are powered by Urubu.
9 |
10 | By others
11 | =========
12 |
13 | [Sigasi Insights][sigasi] - Documentation for Sigasi's tools.
14 |
15 | [Leonardo Uieda][leouieda] - Website about Leonardo's professional activities.
16 |
17 | [PINGA lab][pinga] - Site for the PINGA lab, a research group studying inverse
18 | problems in geophysics.
19 |
20 | For others, by me
21 | =================
22 |
23 | [Vlaamse sofrologen][sofro] - Site of the flemish sophrologists (in Dutch)
24 |
25 | [Troca Vins Naturels][troca] - Natural wines
26 |
27 | MyHDL
28 | =====
29 |
30 | [myhdl_site] - all about MyHDL, for users
31 |
32 | [dev_myhdl_site] - info for MyHDL developers
33 |
34 | Urubu
35 | =====
36 |
37 | [urubu-quickstart] - the Quickstart companion site for Urubu
38 |
39 | [urubu] - this site
40 |
41 | Personal
42 | ========
43 |
44 | [Jan Decaluwe][jan] My site about professional activities
45 |
46 | [Jan Decaluwe / Music][janmusic] My music projects
47 |
48 | [Jan Decaluwe / Opinions][janopinion] My opinions, in Dutch
49 |
50 |
51 | [sigasi]: http://insights.sigasi.com
52 | [leouieda]: http://www.leouieda.com/
53 | [pinga]: http://www.pinga-lab.org/
54 | [sofro]: http://www.vlaamsesofrologen.be
55 | [jan]: http://www.jandecaluwe.com
56 | [janmusic]: http://music.jandecaluwe.com
57 | [janopinion]: http://nl.jandecaluwe.com
58 | [troca]: http://www.troca-vn.be
59 |
--------------------------------------------------------------------------------
/urubu/readers.py:
--------------------------------------------------------------------------------
1 | # Copyright 2014 Jan Decaluwe
2 | #
3 | # This file is part of Urubu.
4 | #
5 | # Urubu is free software: you can redistribute it and/or modify
6 | # it under the terms of the GNU Affero General Public License as published by
7 | # the Free Software Foundation, either version 3 of the License, or
8 | # (at your option) any later version.
9 | #
10 | # Urubu is distributed in the hope that it will be useful,
11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | # GNU Affero General Public License for more details.
14 | #
15 | # You should have received a copy of the GNU Affero General Public License
16 | # along with Urubu. If not, see
8 | {% block title %}
9 |
12 |
13 | {{this.title}}
10 | {% endblock %} 11 |
14 |
15 |
39 |
40 | {% if this.pager %}
41 |
16 | {% block content %}
17 |
22 |
23 | {% block sidebar %}
24 | {% if this.toc %}
25 |
18 | {{this.body}}
19 |
20 | {% endblock %}
21 |
26 |
34 |
35 | {% endif %}
36 | {% endblock %}
37 |
38 | -
42 | {% if this.prev %}
43 |
- ← {{this.prev.title}} 44 | {% endif %} 45 | {% if this.next %} 46 |
- {{this.next.title}} → 47 | {% endif %} 48 |
6 |
7 | {% block breadcrumbs %}
8 |
15 | {% endblock %}
16 |
17 |
63 |
64 | {% endblock %}
65 |
--------------------------------------------------------------------------------
/doc/manual/pagination.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Pagination
3 | layout: page
4 | author: Jay Shafstall
5 | ---
6 |
7 | There are times when an index file will contain more entries than you want to include in a single page. Pagination allows Urubu to automatically split that page into separate pages in your site.
8 |
9 | # Usage
10 |
11 | To enable pagination, add an `items_per_page` attribute to the front matter of an index page. Also add either `items_index` or `items_filter` to say where the list of items should pull from.
12 |
13 | To pull from files in the current directory, with 5 items per page:
14 |
15 | ```
16 | items_per_page: 5
17 | items_index: this
18 | ```
19 |
20 | To pull from a different index contents:
21 |
22 | ```
23 | items_per_page: 5
24 | items_index: news\index.md
25 | ```
26 |
27 | To filter the contents:
28 |
29 | ```
30 | items_per_page: 5
31 | items_filter: mysteries time-loop
32 | ```
33 |
34 | # New Page Variables
35 |
36 | Each of the pages generated by pagination will have three new variables available to layouts.
37 |
38 | `numpages` - the number of total pages generated
39 | `prevpage` - the previous page in the chain
40 | `nextpage` - the next page in the chain
41 |
42 | ## Example pagination controls
43 |
44 | The following is a sample of generating pagination controls in a layout:
45 |
46 | ```
47 | {% if this.numpages %}
48 |
18 | {% block title %}
19 |
22 |
23 | {{this.title}}
20 | {% endblock %} 21 |
24 |
25 | {% block content %}
26 |
59 |
60 | {% include 'footer.html' %}
61 |
62 |
27 |
28 | {{this.body}}
29 |
30 | {% if this.pager %}
31 |
41 | {% endblock %}
42 |
43 | {% block sidebar %}
44 | {% if this.toc %}
45 | -
32 | {% if this.prev %}
33 |
- ← {{this.prev.title}} 34 | {% endif %} 35 | {% if this.next %} 36 |
- {{this.next.title}} → 37 | {% endif %} 38 |
46 |
54 |
55 | {% endif %}
56 | {% endblock %}
57 |
58 |
49 |
65 | {% endif %}
66 | ```
67 |
--------------------------------------------------------------------------------
/doc/css/site.css:
--------------------------------------------------------------------------------
1 | .urubu {
2 | background-image: url("../img/urubu_cover.png");
3 | background-size: cover;
4 | color: white;
5 | }
6 |
7 | body {
8 | position: relative;
9 | padding-top: 50px;
10 | padding-bottom: 20px;
11 | }
12 |
13 | .page-header {
14 | margin-top: 30px;
15 | }
16 |
17 | .breadcrumb {
18 | margin-top: 20px;
19 | }
20 |
21 | .content h2:first-of-type {
22 | margin-top: 0px;
23 | }
24 |
25 | .half-rule {
26 | width: 100px;
27 | margin: 25px auto;
28 | }
29 |
30 |
31 | .fa {
32 | margin-right: 0.5em;
33 | }
34 |
35 | .checklist {
36 | padding: 0;
37 | list-style: none;
38 | }
39 |
40 | /* footer */
41 |
42 | .footer {
43 | margin-top: 30px;
44 | padding-top: 16px;
45 | color: #777;
46 | border-top: 1px solid #eee;
47 | font-size: 90%;
48 | text-align: center;
49 | }
50 |
51 | .footer p {
52 | margin: 0px;
53 | }
54 |
55 | /* toc */
56 |
57 | .sidebar {
58 | font-size: 90%;
59 | line-height: normal
60 | }
61 |
62 | .toc ul {
63 | padding-left: 0;
64 | list-style: none;
65 | }
66 |
67 | .toc ul li {
68 | padding-top: 3px;
69 | }
70 |
71 | .toc ul ul {
72 | padding-left: 10px;
73 | font-size: 95%;
74 | }
75 |
76 | /* heading scrolling */
77 |
78 | h2[id]:before,
79 | h3[id]:before{
80 | content: "";
81 | display: block;
82 | height: 70px;
83 | margin-top:-70px;
84 | }
85 |
86 | /* affix hacks from boostrap 3.0 docs */
87 | .sidebar.affix {
88 | position: static;
89 | }
90 |
91 | @media (min-width: 992px) {
92 | /* Widen the fixed sidebar */
93 | .sidebar.affix,
94 | .sidebar.affix-bottom {
95 | width: 213px;
96 | }
97 | .sidebar.affix {
98 | position: fixed; /* Undo the static from mobile first approach */
99 | top: 80px;
100 | }
101 | .sidebar.affix-bottom {
102 | position: absolute; /* Undo the static from mobile first approach */
103 | }
104 | }
105 |
106 | @media (min-width: 1200px) {
107 | /* Widen the fixed sidebar again */
108 | .sidebar.affix,
109 | .sidebar.affix-bottom {
110 | width: 263px;
111 | }
112 | }
113 |
--------------------------------------------------------------------------------
/doc/_build/css/site.css:
--------------------------------------------------------------------------------
1 | .urubu {
2 | background-image: url("../img/urubu_cover.png");
3 | background-size: cover;
4 | color: white;
5 | }
6 |
7 | body {
8 | position: relative;
9 | padding-top: 50px;
10 | padding-bottom: 20px;
11 | }
12 |
13 | .page-header {
14 | margin-top: 30px;
15 | }
16 |
17 | .breadcrumb {
18 | margin-top: 20px;
19 | }
20 |
21 | .content h2:first-of-type {
22 | margin-top: 0px;
23 | }
24 |
25 | .half-rule {
26 | width: 100px;
27 | margin: 25px auto;
28 | }
29 |
30 |
31 | .fa {
32 | margin-right: 0.5em;
33 | }
34 |
35 | .checklist {
36 | padding: 0;
37 | list-style: none;
38 | }
39 |
40 | /* footer */
41 |
42 | .footer {
43 | margin-top: 30px;
44 | padding-top: 16px;
45 | color: #777;
46 | border-top: 1px solid #eee;
47 | font-size: 90%;
48 | text-align: center;
49 | }
50 |
51 | .footer p {
52 | margin: 0px;
53 | }
54 |
55 | /* toc */
56 |
57 | .sidebar {
58 | font-size: 90%;
59 | line-height: normal
60 | }
61 |
62 | .toc ul {
63 | padding-left: 0;
64 | list-style: none;
65 | }
66 |
67 | .toc ul li {
68 | padding-top: 3px;
69 | }
70 |
71 | .toc ul ul {
72 | padding-left: 10px;
73 | font-size: 95%;
74 | }
75 |
76 | /* heading scrolling */
77 |
78 | h2[id]:before,
79 | h3[id]:before{
80 | content: "";
81 | display: block;
82 | height: 70px;
83 | margin-top:-70px;
84 | }
85 |
86 | /* affix hacks from boostrap 3.0 docs */
87 | .sidebar.affix {
88 | position: static;
89 | }
90 |
91 | @media (min-width: 992px) {
92 | /* Widen the fixed sidebar */
93 | .sidebar.affix,
94 | .sidebar.affix-bottom {
95 | width: 213px;
96 | }
97 | .sidebar.affix {
98 | position: fixed; /* Undo the static from mobile first approach */
99 | top: 80px;
100 | }
101 | .sidebar.affix-bottom {
102 | position: absolute; /* Undo the static from mobile first approach */
103 | }
104 | }
105 |
106 | @media (min-width: 1200px) {
107 | /* Widen the fixed sidebar again */
108 | .sidebar.affix,
109 | .sidebar.affix-bottom {
110 | width: 263px;
111 | }
112 | }
113 |
--------------------------------------------------------------------------------
/urubu/httphandler.py:
--------------------------------------------------------------------------------
1 | # Copyright 2015 Sreepathi Pai
2 | #
3 | # This file is part of Urubu.
4 | #
5 | # Urubu is free software: you can redistribute it and/or modify
6 | # it under the terms of the GNU Affero General Public License as published by
7 | # the Free Software Foundation, either version 3 of the License, or
8 | # (at your option) any later version.
9 | #
10 | # Urubu is distributed in the hope that it will be useful,
11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 | # GNU Affero General Public License for more details.
14 | #
15 | # You should have received a copy of the GNU Affero General Public License
16 | # along with Urubu. If not, see -
50 | {% if this.prevpage %}
51 |
- < 52 | {% endif %} 53 | {% for page in this.pages %} 54 | {% if page.pagenum == this.thispage %} 55 |
- {{page.pagenum}} 56 | {% else %} 57 |
- {{page.pagenum}} 58 | {% endif %} 59 | {% endfor %} 60 | {% if this.nextpage %} 61 |
- > 62 | {% endif %} 63 |
48 |
49 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
--------------------------------------------------------------------------------
/urubu/tests/no_index/_build/page.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
50 |
52 |
53 | test
51 |
54 |
55 |
63 |
64 |
65 |
66 |
56 |
60 |
61 |
62 |
57 |
58 |
59 |
48 |
49 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
--------------------------------------------------------------------------------
/urubu/tests/no_yamlfm/_build/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
50 |
52 |
53 | page
51 |
54 |
55 |
63 |
64 |
65 |
66 |
56 |
60 |
61 |
62 |
57 |
58 |
59 |
48 |
49 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
--------------------------------------------------------------------------------
/urubu/tests/undef_ref/_build/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
50 |
52 |
53 | test
51 |
54 |
55 |
63 |
64 |
65 |
66 |
56 |
60 |
61 |
62 |
57 |
58 |
59 |
48 |
49 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
--------------------------------------------------------------------------------
/urubu/tests/undef_ref/_build/page.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
50 |
52 |
53 | test
51 |
54 |
55 |
63 |
64 |
65 |
66 |
56 |
60 |
61 |
62 |
57 |
58 |
59 |
48 |
49 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
--------------------------------------------------------------------------------
/urubu/tests/ambig_refid/_build/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
50 |
52 |
53 | page
51 |
54 |
55 |
63 |
64 |
65 |
66 |
56 |
60 |
61 |
62 |
57 |
58 |
59 |
48 |
49 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
--------------------------------------------------------------------------------
/urubu/tests/ambig_refid/_build/page.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
50 |
52 |
53 | test
51 |
54 |
55 |
63 |
64 |
65 |
66 |
56 |
60 |
61 |
62 |
57 |
58 |
59 |
48 |
49 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
--------------------------------------------------------------------------------
/urubu/tests/date_format/_build/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
50 |
52 |
53 | page
51 |
54 |
55 |
63 |
64 |
65 |
66 |
56 |
60 |
61 |
62 |
57 |
58 |
59 |
48 |
49 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
--------------------------------------------------------------------------------
/urubu/tests/date_format/_build/page.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
50 |
52 |
53 | test
51 |
54 |
55 |
63 |
64 |
65 |
66 |
56 |
60 |
61 |
62 |
57 |
58 |
59 |
48 |
49 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
--------------------------------------------------------------------------------
/urubu/tests/ignore_patterns/_build/page.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
50 |
52 |
53 | page
51 |
54 |
55 |
63 |
64 |
65 |
66 |
56 |
60 |
61 |
62 |
57 |
58 |
59 |
48 |
49 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
--------------------------------------------------------------------------------
/urubu/tests/undef_anchor/_build/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
50 |
52 |
53 | page
51 |
54 |
55 |
63 |
64 |
65 |
66 |
56 |
60 |
61 |
62 |
57 |
58 |
59 |
48 |
49 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
--------------------------------------------------------------------------------
/urubu/tests/undef_content/_build/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
50 |
52 |
53 | test
51 |
54 |
55 |
63 |
64 |
65 |
66 |
56 |
60 |
61 |
62 |
57 |
58 |
59 |
48 |
49 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
--------------------------------------------------------------------------------
/urubu/tests/undef_content/_build/page.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
50 |
52 |
53 | test
51 |
54 |
55 |
63 |
64 |
65 |
66 |
56 |
60 |
61 |
62 |
57 |
58 |
59 |
48 |
49 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
--------------------------------------------------------------------------------
/urubu/tests/undef_ref_md/_build/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
50 |
52 |
53 | page
51 |
54 |
55 |
63 |
64 |
65 |
66 |
56 |
60 |
61 |
62 |
57 |
58 |
59 |
48 |
49 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
--------------------------------------------------------------------------------
/urubu/tests/undef_ref_md/_build/page.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
50 |
52 |
53 | test
51 |
54 |
55 |
63 |
64 |
65 |
66 |
56 |
60 |
61 |
62 |
57 |
58 |
59 |
48 |
49 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
--------------------------------------------------------------------------------
/urubu/tests/ignore_patterns/_build/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
50 |
52 |
53 | page
51 |
54 |
55 |
63 |
64 |
65 |
66 |
56 |
60 |
61 |
62 |
57 |
58 |
59 |
48 |
49 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
--------------------------------------------------------------------------------
/urubu/tests/undef_anchor/_build/page.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
50 |
52 |
53 | test
51 |
54 |
55 |
63 |
64 |
65 |
66 |
56 |
60 |
61 |
62 |
57 |
58 |
59 |
48 |
49 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
--------------------------------------------------------------------------------
/urubu/tests/undef_key/_build/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
50 |
52 |
53 | page
51 |
54 |
55 |
63 |
64 |
65 |
66 |
56 |
60 |
61 |
62 |
57 |
59 | Define an anchor.
58 |
49 |
50 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
77 |
--------------------------------------------------------------------------------
/urubu/tests/undef_key/_build/page.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
51 |
53 |
54 | test
52 |
55 |
56 |
64 |
65 |
66 |
67 |
57 |
61 |
62 |
63 |
58 |
59 |
60 |
49 |
50 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
77 |
--------------------------------------------------------------------------------
/urubu/tests/undef_layout/_build/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
51 |
53 |
54 | page
52 |
55 |
56 |
64 |
65 |
66 |
67 |
57 |
61 |
62 |
63 |
58 |
59 |
60 |
49 |
50 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
77 |
--------------------------------------------------------------------------------
/urubu/tests/undef_ref_md/_build/page2.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
51 |
53 |
54 | test
52 |
55 |
56 |
64 |
65 |
66 |
67 |
57 |
61 |
62 |
63 |
58 |
59 |
60 |
48 |
49 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
--------------------------------------------------------------------------------
/urubu/tests/undef_reflink_url/_build/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
50 |
52 |
53 | page
51 |
54 |
55 |
63 |
64 |
65 |
66 |
56 |
60 |
61 |
62 |
57 |
59 | Reference an undefined page: [undefined_page].
58 |
49 |
50 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
77 |
--------------------------------------------------------------------------------
/urubu/tests/undef_tag_layout/_build/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
51 |
53 |
54 | test
52 |
55 |
56 |
64 |
65 |
66 |
67 |
57 |
61 |
62 |
63 |
58 |
59 |
60 |
49 |
50 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
76 |
77 |
--------------------------------------------------------------------------------
/doc/manual/extensions.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Markdown extensions
3 | layout: page
4 | pager: true
5 | author: Jan Decaluwe
6 | ---
7 |
8 | Introduction
9 | ============
10 |
11 | Urubu implements a number of Markdown extensions. These extensions do not
12 | change or extend the Markdown syntax. Rather, they add interesting features by
13 | processing and rendering the Markdown source in more sophisticated ways.
14 |
15 | The extensions are described in more detail below.
16 |
17 | Project-wide reference ids
18 | ==========================
19 |
20 | Urubu implements a Markdown extension to resolve project-wide reference ids.
21 | This means that all pages in the project are automatically available as
22 | reference ids, and can be referred to using Markdown's syntax for reference
23 | links.
24 |
25 | This feature is described in more detail in the sections
26 | [/manual/structure#Project-wide reference ids] and [/manual/authoring#Reference
27 | links]. It is Urubu's most important extension and a fundamental feature of the
28 | tool.
29 |
30 | Bootstrap-specific extensions
31 | =============================
32 |
33 | Urubu is designed to play well with [bootstrap]. To use certain Bootstrap
34 | features, it has extensions that add Bootstrap classes to certain tags.
35 | More specifically, the following classes are added:
36 |
37 | table
38 | : Added to the `
51 |
53 |
54 | test
52 |
55 |
56 |
64 |
65 |
66 |
67 |
57 |
61 |
62 |
63 |
58 |
59 |
60 |