{{ body }}
20 |21 | 22 | 23 | {% endif -%} 24 | -------------------------------------------------------------------------------- /templates/tags/single.html: -------------------------------------------------------------------------------- 1 | {% import "macros/article.html" as article %} 2 | {%- extends "base.html" -%} 3 | 4 | {%- block total_posts %} 5 | {%- if term and term.pages and term.pages | length == 1 %} 6 |
4 | {%- if page.date %} 5 | 6 | {% endif -%} 7 | {%- if page.title %} 8 | {{ page.title }} 9 | {% endif -%} 10 |
11 | {%- if page.taxonomies and page.taxonomies.tags %} 12 |-
13 | {%- for tag in page.taxonomies.tags %}
14 |
- {{ tag }} 15 | {% endfor -%} 16 |
6 |
13 |
14 | I've created kangae from scratch and it is not based on any other theme. However, I was inspired to
15 | create kangae after I came across [Wolfgang Müller's microblog][3]. Thanks Wolf!
16 |
17 | kangae is licensed under the [NCSA license][5], which is quite similar to the BSD-3-Clause license.
18 | Unlike BSD-3-Clause, NCSA also covers documentation of a project.
19 |
20 | # Showcase
21 |
22 | Here's a list of websites using the kangae theme
23 |
24 | - [ayushnix microblog][4]
25 |
26 | If you want to mention your website in this section, please raise a pull request.
27 |
28 | # Installation
29 |
30 | Before using this theme, [install zola][6]. After you've installed zola,
31 |
32 | ```
33 | $ zola init microblog
34 | > What is the URL of your site? (https://example.com):
35 | > Do you want to enable Sass compilation? [Y/n]:
36 | > Do you want to enable syntax highlighting? [y/N]:
37 | > Do you want to build a search index of the content? [y/N]:
38 | $ cd microblog/
39 | ```
40 |
41 | kangae doesn't use Sass or syntax highlighting so if you don't want to use custom Sass code or
42 | enable syntax highlighting, answer the 2nd and 3rd question with a 'no'. kangae also doesn't use any
43 | JavaScript library to search content. If you don't intend to install a JavaScript library to enable
44 | search on your microblog, answer 'no' to the last question as well.
45 |
46 | If you intend to publish your microblog on a forge like GitHub, initialize an empty git repository
47 | using
48 |
49 | ```
50 | $ git init
51 | $ git commit --allow-empty -m 'initial empty root commit'
52 | ```
53 |
54 | If you don't want to make an empty commit, add and commit a README or a LICENSE file instead.
55 |
56 | At this point, you can install kangae using one of the following methods
57 |
58 | ## using `git subtree`
59 |
60 | ```
61 | $ git subtree add -P themes/kangae/ --squash https://github.com/ayushnix/kangae.git master
62 | ```
63 |
64 | ## using `git submodule`
65 |
66 | ```
67 | $ git submodule add https://github.com/ayushnix/kangae.git themes/kangae
68 | ```
69 |
70 | ## download kangae in themes directory
71 |
72 | If you want to keep things simple and figure out version control later, you can
73 |
74 | ```
75 | $ git clone https://github.com/ayushnix/kangae.git themes/kangae
76 | ```
77 |
78 | # Configuration
79 |
80 | To begin using kangae after installing it,
81 |
82 | ```
83 | $ cp themes/kangae/config.toml ./
84 | $ sed -i 's;# theme =\(.*\);theme =\1;' config.toml
85 | ```
86 |
87 | The [`config.toml`][7] file of kangae has been documented carefully using TOML comments. If you have
88 | any questions about configuring kangae which haven't been answered in the `config.toml` file itself,
89 | please [raise an issue][8].
90 |
91 | ## Shortcodes
92 |
93 | kangae provides several shortcodes that can be used to add content in an accessible manner
94 |
95 | ### kaomoji `(・_・)ノ`
96 |
97 | If you want to use kaomoji in your posts, you can use insert them in an accessbile manner using
98 |
99 | ```
100 | I don't know. {{ kaomoji(label="shrug kaomoji", text="╮( ˘_˘ )╭") }} I've never thought about it.
101 | ```
102 |
103 | Providing a value for the `label` is optional but highly recommended. A short text should be
104 | mentioned that explains what the kaomoji means to convey. The value of `text` should be the actual
105 | emoticon itself.
106 |
107 | This shortcode can also be used for any other ASCII emoticon that can fit in an inline paragraph.
108 | This includes western emoticons such as `;)` and combination emoticons such as `<(^_^<)`.
109 |
110 | ### Quotes
111 |
112 | You can add quotes in your microblog posts using
113 |
114 | ```
115 | {% quote(author="Nara Shikamaru") %}
116 | You would think just this once, when it was life or death, I could pull through.
117 | {% end %}
118 | ```
119 |
120 | This is the most basic form of improvement in writing quotes over simply using `>` in markdown.
121 |
122 | If you want to mention the name of the source from where the quote has been taken, such as the name
123 | of the book or a movie, you can use
124 |
125 | ```
126 | {% quote(citation="Mass Effect 3", author="Javik") %}
127 | Stand in the ashes of a trillion dead souls, and ask the ghosts if honor matters. The silence is your answer.
128 | {% end %}
129 | ```
130 |
131 | A `citeurl` can also be given as an argument to this shortcode to provide the actual URL from where
132 | the source is borrowed.
133 |
134 | ```
135 | {% quote(author="Edward Snowden", citeurl="https://old.reddit.com/r/IAmA/comments/36ru89/just_days_left_to_kill_mass_surveillance_under/crglgh2/") %}
136 | Arguing that you don't care about the right to privacy because you have nothing to hide is no different than saying you don't care about free speech because you have nothing to say.
137 | {% end %}
138 | ```
139 |
140 | A live preview of these how these shortcodes look like can be found on [this blog post][14].
141 |
142 | ## Optional Features
143 |
144 | kangae includes some optional features that aren't enabled by default
145 |
146 | - [style external links using a ↗ unicode symbol][11]
147 |
148 | # Donate
149 |
150 | If you found kangae helpful in creating your own microblog website, please consider supporting me by
151 | buying me a coffee :coffee:
152 |
153 | kangae screenshots on desktop and mobile
7 | 8 |  9 |  10 |  11 |  12 |
154 | 
155 |
156 | If you're in India, you can also use UPI for donations. My UPI address is `ayushnix@ybl`.
157 |
158 | # Notes
159 |
160 | Although I'm not a web developer, I am interested in learning HTML and CSS to create lightweight
161 | textual websites. You may be interested in reading [my log about how I learned HTML and CSS][12].
162 | However, that page is just an unorganized dump of my thoughts and isn't a polished blog post.
163 | [Seirdy's blog post on creating textual websites][13] is probably a better reference.
164 |
165 | # TODO (maybe?)
166 |
167 | - (responsive) image shortcodes
168 | - run prettier on HTML and CSS before deployment
169 | - twitter and mastodon shortcodes
170 | - add optional support for cross posting and commenting on mastodon without using JS
171 | - add optional support for [giscus][9] and [loading mastodon comments][10]
172 | - add shortcode for asciinema
173 | - add shortcode for blockquote and citation
174 | - pagination
175 | - light and dark mode switch
176 | - content tabs
177 | - microdata and microformats2
178 |
179 | [1]: https://kangae.ayushnix.com/
180 | [2]: https://www.getzola.org/
181 | [3]: https://zunzuncito.oriole.systems/
182 | [4]: https://microblog.ayushnix.com
183 | [5]: LICENSE
184 | [6]: https://www.getzola.org/documentation/getting-started/installation/
185 | [7]: config.toml
186 | [8]: https://github.com/ayushnix/kangae/issues/new
187 | [9]: https://giscus.app/
188 | [10]: https://carlschwan.eu/2020/12/29/adding-comments-to-your-static-blog-with-mastodon/
189 | [11]: https://github.com/ayushnix/kangae/blob/master/static/css/style-external-links.css
190 | [12]: https://wiki.ayushnix.com/frontend/creating-a-website/
191 | [13]: https://seirdy.one/2020/11/23/website-best-practices.html
192 | [14]: https://kangae.ayushnix.com/being-shikamaru-102/
193 |
--------------------------------------------------------------------------------
/templates/base.html:
--------------------------------------------------------------------------------
1 | {%- import "macros/head.html" as head -%}
2 |
3 |
4 |
5 |
6 | {%- block basic_meta -%}
7 | {{ head::basic_meta() }}
8 | {%- endblock -%}
9 |
10 | {%- block color_meta -%}
11 | {{ head::color_meta() }}
12 | {%- endblock %}
13 |
14 | {%- block ogtitle -%}
15 | {{ head::ogtitle(tl="") }}
16 | {%- endblock -%}
17 |
18 | {%- block opengraph_basic_meta -%}
19 | {{ head::opengraph_basic_meta() }}
20 | {%- endblock -%}
21 |
22 | {%- block opengraph_optional_meta -%}
23 | {{ head::opengraph_optional_meta() }}
24 | {%- endblock -%}
25 |
26 | {%- block favicon -%}
27 | {{ head::favicon() }}
28 | {%- endblock -%}
29 |
30 | {%- block manifest -%}
31 | {{ head::manifest() }}
32 | {%- endblock -%}
33 |
34 | {%- block feed -%}
35 | {{ head::feed() }}
36 | {%- endblock -%}
37 |
38 | {%- block style -%}
39 | {{ head::style() }}
40 | {%- endblock -%}
41 |
42 | {%- block base_canonical -%}
43 | {{ head::base_canonical() }}
44 | {%- endblock -%}
45 |
46 | {%- block title -%}
47 | {{ head::head_title(tl="") }}
48 | {%- endblock -%}
49 |
50 |
51 | -
63 | {%- block primary_header %}
64 | {%- if config.extra.author %}
65 |
{{ config.extra.author }}
66 | {% endif -%}
67 | {%- if config.extra.username %}
68 | - @{{ config.extra.username }} 69 | {% endif -%} 70 | {%- block header_description %} 71 | {%- if config.description %} 72 |
- {{ config.description }} 73 | {% endif -%} 74 | {% endblock -%} 75 | {%- block total_posts %} 76 | {%- if section.pages and section.pages | length == 1 %} 77 |
- {{ section.pages | length }} post and counting ... 78 | {%- elif section.pages and section.pages | length > 1 %} 79 |
- {{ section.pages | length }} posts and counting ... 80 | {% endif -%} 81 | {% endblock -%} 82 | {% endblock -%} 83 |