Skip to content

Post Format

This article explains the format of articles in this website.

Notice on migrated posts

Some blog posts here are migrated from other web sources written by me, and some of them may not strictly respect the following format.

Warning

This is my own blog, and some stuffs may be changed without notice.

Titles

For every blog post, it should have exactly one category that is classified as part of series. The main title format of a blog post would be {ABBREVIATED SERIES NAME} {NUMBERING}. {POST TITLE}, and post URL should be series/{ABBREVIATED SERIES NAME}/{NUMBERING}. For every non blog post like this article, it should have no category at all. There is no strict title naming rule on non blog posts.

I use h1 as main title of a post, and some posts does not have h1 section in raw file. I use h2 and h3 as paragraph titles of a post. Every title provides a permalink for easier reference. The navigation provided by mkdocs-material is available at the right side, if your screen is large enough.

Metadata

Every blog post will provide following metadata;

  • Last updated date and created date of an article.

    • If the original post date is explicitly specified, use that for created date instead.
    • If a commit hash is available, provide it with a link.

  • A number of active users visited this page since the beginning of the blog.

    • This is different from total views.
    • Since I am not using realtime data, this metadata is not available if the data is not available from GA4 yet.

    Disclaimer

    The "number of active users" statistics is analyzed anonymously and I do not provide any personalized information(who visited here, etc) on this blog, since I do not intend to provide it and also I have no way to get it from GA4 API.

  • Git edit history URL via Github. (for blog posts)

Admonitions

I use built-in admonitions featured by mkdocs-material. For typical admonitions, I use note, info, and quote types in most cases and occasionally use warning and danger types. However, I customized some following stuffs, thanks for CSS animations.

Disclaimer

Migrated

References

Caption

Copyright

Formula

Resources

Almost all custom icons here are provided by SVG Repo.

References

I try to use official links as possible as I can. If I fail to find good enough reference in a reasonable time, I may reference some lower quality articles like namu.wiki.