Admonition tags are used to give readers important reminders.
Commonly used admonition tags include the following:
- Error Message
They are used to communicate errors, incompletion, or serious bugs on my side. They are not about the content of the page or post, but simply a reminder for myself about system errors and maintenances.
Construction Ongoing
This is not a finished post. The final version may have drastic differences as compared to this draft.
Construction Ongoing
I am working on this page...
To be continued...
- Information Message
They are used to communicate meta-information about the post, such as special status of the post.
Transplanted Post
After setting up this website I am gradually transferring all my previous blogs stored locally and in other blog system towards here. This is one of them. Thus, you should be aware that the date and time displayed on this blog is not accurate.
Post Series
This posts belongs to the series [series-name]. You can see all posts in this series here.
- Note Message
They are used to communicate trivial information about the post content.
Update Ongoing
This list will be updated.
By The Way
[Some trivia]
Not My Code
This snippet of codes are not my work. They are taken from...
- Warning Message
They are used to communicate important information about the post content.
Expected Reader Experience: None
This post is good for readers having zero or very limited knowledge on the topic: [topic].
Expected Reader Experience: None
This post is good for readers having zero or very limited knowledge on the topic: [topic].
However, since this post belongs to a series, you are expected to master the previous posts in the series.
Expected Reader Experience: Intermediate
This post is good for readers having reasonable mastery on the topic: [topic].
Knowledge on the following are especially crucial: [sub-topic], [sub-topic].
Expected Reader Experience: Advanced
This post is good for readers who are very familiar on the topic: [topic].
Fragmented Content
This post content may appear fragmented or disjointed for I only noted down things I think I need to look at a second time. This post is primarily meant for personal consumption, but some snippets might interest you.
Known Bugs
[Some reminders about a known bug.]
Untested Codes
This snippet of codes has not been tested yet and are thus for illustration of concepts only.
Not My Codes
This snippet of codes are not my work. They are taken.modified from...
Not My Codes
This snippet of codes are not my work. They are taken.modified from...
Common Pitfalls
[Some reminders about a confusing point.]
GitHub Discussions