YYX's Personal Website

This repository is for my personal website powered by Pelican.

Theme is based on MinimalX & MinimalXY so I named it to MinimalXYZ which is in theme/MinimalXYZ.

Usage

Install Python dependencies.

virtualenv venv
. venv/bin/activate
pip install pelican markdown

Clone plug-ins.

git clone https://github.com/getpelican/pelican-plugins.git

Start local web server. Write articles in Markdown and save them to content.

make devserver

Access local web site at http://localhost:8000, use ./develop_server.sh stop to stop development server).

Publish to Github once done.

make publish
git add .
git commit -m "update"
git push

CNAME is in content/extra, replace it to your domain.

In order to upload whole project directory (then I can write article and generate it wherever I want), I use <repo name>/docs folder as web root, method can be found from Github help manual. If you don't have custom domain, use <user name>.github.io/<repo name> to access your website, or you can just publish the content in docs to the root of <user name>.github.io.

Article structure

Meta data:

Title: test # required
Date: 2017-11-05 00:00:00 # required
Slug: URL path of generated page
Summary: summary content
Summary_en: summary in English
Tags: tag1, tag2
HeaderImage: ../statics/article_images.jpg
HeaderImageCaption: caption of header image

Static resources of articles are in content/statics.

Pages are in content/_pages.