hehe1111 / hibikilogy-on-vuepress

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Hibikilogy on VuePress

A mirror of hibikilogy.

Power by VuePress 2 + vuepress-theme-gungnir.

How to add a post

Add a .md file under the docs/posts/ directory. Filename format is YYYY-MM-DD-<your filename here>

Post header format:

---
layout: Post
title: <Title of the post. Required.>
subtitle: <Subtitle of the post. Optional.>
author: <Author of the post. Required.>
date: <YYYY-MM-DD>
useHeaderImage: <true | false. Optional.>
headerImage: <Header image. Can be a absolute http url or a relative file path. Required.>
headerMask: <A CSS color value. e.g: rgba(40, 57, 101, .4). Optional.>
catalog: <Whether to set up a catalog on the post page. Default: false.>
original: <The origin address of the post. Optional.>
tags:
  - <tag1>
  - <tag2>
  - ...
---

A short description of the post ...

<!-- more -->

Here is the content of the post ...

Example:

---
layout: Post
title: Day 1
subtitle: Nothing to write about
author: Nobody
date: 9999-12-31
useHeaderImage: true
headerImage: https://this/is/a/image/path.png
headerMask: rgba(40, 57, 101, .4)
catalog: true
original: https://this/is/a/url/to/a/post
tags:
    - post101
    - Nothing
    - DONE
---

Nothing to write about.

<!-- more -->

## TODO

Lorem, ipsum dolor sit amet consectetur adipisicing elit. Maiores, voluptate? Iste maiores similique optio voluptatum sunt modi mollitia labore repellat aspernatur, facere eius, officia culpa perspiciatis asperiores impedit reprehenderit non!

The value of the headerImage can be a local file path

headerImage: /img/header.jpg

About

License:Apache License 2.0


Languages

Language:TypeScript 47.5%Language:Vue 25.4%Language:SCSS 24.7%Language:CSS 1.2%Language:JavaScript 0.8%Language:HTML 0.4%Language:Shell 0.0%