Xoxzo's Official Blogs and sources
This document serves as a quick guide and reminder on how to work with Xoxzo's blog using Markdown and Pelican.
**virtualenv -p python3** venv
source venv/bin/activate
*IMPORTANT! upgrade pip first:*
pip install -U pip
pip install -r requirements.txt
make build
After preparing your environment, you can create contents by creating .md files in the content directory. Before you start working, pull the latest from GitHub first:
git pull origin master
Once you've written your articles,
make html
make serve
OR
make devserver # that will do make html and make serve
and access localhost:8000 via your browser to make sure everything looks ok.
If everything looks good, commit and push it to GitHub:
git add <file>
git commit
git push origin master
make github
Please follow the format of the filenames that you see, i.e append the language at the end of the file name after the filename itself:
合計 16
drwxr-xr-x 2 iqbal iqbal 4096 12月 19 09:23 .
drwxrwxr-x 12 iqbal iqbal 4096 12月 28 20:43 ..
-rw-rw-r-- 1 iqbal iqbal 1221 12月 17 21:17 end-of-kof-en.md
-rw-rw-r-- 1 iqbal iqbal 1166 12月 17 21:17 end-of-kof-ja.md
Categories are decided by the directory which you have your .md files in. Basically this means we'll want only one category for an article, so choose carefully which category your article can be in and only create a new directory (category) when there are no suitable categories.
If you want to connect your article to different topics, use the Tags metadata instead.
These metadata is required for all articles
Title:
Date:
Author:
Tags:
Slug:
Summary:
It is mandatory to specify Lang metadata for each article, like this:
Title: Participating KOF-Kansai Open Source Forum
Date: 2016-11-14 11:00
Slug: kof-2016-report
Lang: en
Modified: 2012-11-14 11:00
Tags: kof; osaka; exhibition;
Author: Aiko Yokoyama
Summary: We participated in the KOF 2016 and this is what we think
Translated article should have the same Date metadata as the original text for SEO.
To show particular thumbnail image when the article is shared, fill Thumbnail metadata with the image url, like this:
Thumbnail: images/xoxzo_opengraph.jpg
Otherwise, the default image will appear.
To translate string in templates, make the string translatable:
{% trans %}Who we are ?{% endtrans %}
Then run:
make pot_translation
This will create translation file in locales/ja/LC_MESSAGES/messages.po. Translate
the string and then run:
make compile_translation
make html
You can find author's footer files to edit here:
themes/xoxzo/templates/profile/
Make sure that you are using exactly same author's name with profile file name. Otherwise Pelican cannot find the profile.
If you want to add caption for images, use html tag with caption class instead of markdown syntax.
For example:
<a class="caption" href="https://sample-img-caption-link.html">Caption1</a>
or
<span class="caption">Caption2</span>
If you want to show "editor's pick" section, then you need to show 3 articles there, per language.
To may control selected articles by using 2 additional metadata, Series: and series_index:, e.g.:
...
Thumbnail: images/python-import.jpg
Summary: Pythonのimportのサーチパスに関する話題
Series: featured-ja
series_index: 2
You set featured-ja or featured-en for JA or EN pages.
series_index: may take 1, 2 or 3 - it orders articles, e.g. index 2 sets article to the middle position.