Implementation:Mbzuai oryx Awesome LLM Post training Markdown Badge Formatting
| Knowledge Sources | |
|---|---|
| Domains | Curation, Documentation |
| Last Updated | 2026-02-08 07:30 GMT |
Overview
Concrete pattern for formatting paper entries in the awesome-list README using markdown tables, bullet lists, and shields.io venue badges.
Description
This is a Pattern Doc documenting the two formatting patterns used in README.md for paper entries:
Table format (Survey section): Each row contains a paper title, publication date, and a linked reference to the paper URL.
Bullet format (all other sections): Each entry is a bulleted list item with the paper title, a [Paper] link, and a shields.io badge showing the venue and year with color coding (red for arXiv, blue for peer-reviewed venues).
Usage
Apply the appropriate format when adding new papers to the README. Use the table format for the Survey section and the bullet format for all other sections.
Code Reference
Source Location
- Repository: Awesome-LLM-Post-training
- File: README.md
- Lines: 51-291 (paper listing sections)
Pattern Specification
Table Format (Survey Section)
| Title | Publication Date | Link |
|---------------------------------|----------------|---------------------------------|
| A Survey on Post-training of Large Language Models | 8 Mar 2025 | [Arxiv](https://arxiv.org/abs/2503.06072) |
Bullet Format (Other Sections)
* Paper Title [[Paper]](https://arxiv.org/abs/XXXX.XXXXX) 
* Paper Title [[Paper]](https://arxiv.org/abs/XXXX.XXXXX) 
Badge Color Rules
Red badge: arXiv preprints → https://img.shields.io/badge/arXiv-{year}-red
Blue badge: Peer-reviewed venues → https://img.shields.io/badge/{venue}-{year}-blue
Venues using blue: NeurIPS, ACL, ICLR, ICML, AAAI, EMNLP, COLM, etc.
I/O Contract
Inputs
| Name | Type | Required | Description |
|---|---|---|---|
| Paper title | str | Yes | Title of the paper |
| Paper URL | str | Yes | Link to the paper (arXiv, OpenReview, etc.) |
| Venue | str | Yes | Publication venue name |
| Year | int | Yes | Publication year |
| Section type | str | Yes | "survey" for table format, other for bullet format |
Outputs
| Name | Type | Description |
|---|---|---|
| Formatted entry | str | Markdown-formatted paper entry (table row or bullet item) |
Usage Examples
Adding a Survey Paper (Table Format)
| LLM Post-Training: A Deep Dive into Reasoning Large Language Models | 28 Feb 2025 | [Arxiv](https://arxiv.org/pdf/2502.21321) |
Adding a Conference Paper (Bullet Format, Blue Badge)
* Direct Preference Optimization: Your Language Model is Secretly a Reward Model [[Paper]](https://arxiv.org/abs/2305.18290) 
Adding an arXiv Preprint (Bullet Format, Red Badge)
* DeepSeek-R1: Incentivizing Reasoning Capability in LLMs via Reinforcement Learning [[Paper]](https://arxiv.org/abs/2501.12948) 