--- layout: default title: "Markdown" description: "Guide to Markdown syntax used across The Sunil Abraham Project (TSAP), including a practical cheatsheet." categories: [TSAP Documentation] permalink: /tsap/markdown/ created: 2026-03-18 --- **Markdown** is a lightweight markup language used to format text using simple and readable syntax. It allows content to be written in plain text while supporting headings, links, lists, and other structural elements. Most pages in The Sunil Abraham Project (TSAP) are written in Markdown, typically using the `.md` file format. This ensures that content remains clean, version-controlled, and easy to maintain within the GitHub-based workflow. **Note:** This page is a practical reference and may be expanded over time. ## Markdown Cheatsheet

You write You get

Emphasis

*italics* italics

**bold** bold

***bold and italics*** bold and italics

~~strikethrough~~ ~~strikethrough~~

Headings

# Heading 1

Heading 1

## Heading 2

Heading 2

### Heading 3

Heading 3

#### Heading 4

Heading 4

Links and Images

[Link text](https://example.com) Link text

[Link text](https://example.com "Title") Link text (with tooltip)

![Alt text](image.png) Displays an image

![Alt text](image.png "Caption") Displays an image with caption tooltip

Lists

- Item
- Another item

Item
Another item

1. First
2. Second

First
Second

- Item
- Nested item

Item
- Nested item

- [ ] Unchecked task
- [x] Checked task ☐ Unchecked task
☑ Checked task

Blockquotes and Code

> This is a quote.

This is a quote.

> Line one.
> Line two.

Line one.
Line two.

`inline code` inline code

```
code block
```

code block

```python
print("Hello")
```

Syntax-highlighted code block (Python)

Tables

| Col 1 | Col 2 |
|-------|-------|
| A     | B     |

Col 1	Col 2
A	B

| Left | Centre | Right |
|:-----|:------:|------:|

Left, centre, and right column alignment

Other Elements

---

\*not italic\* *not italic* (escaped character)

Text<br>New line Text
New line (line break)

  (non-breaking space)

[^1] and [^1]: Footnote text Footnote reference and definition

## Code Block Examples The following five examples demonstrate common TSAP writing patterns. **1. Article front matter and introduction** ```markdown --- layout: default title: "Example Article" description: "A short description of the article." categories: [Articles] permalink: /tsap/example/ created: 2026-03-18 --- This is the opening paragraph of an article. It introduces the subject clearly and concisely before moving into sections. ``` **2. Sections with headings and lists** ```markdown ## Background This section provides context for the subject. Keep paragraphs short and focused on a single idea. ## Key Points - First important point about the subject - Second point with additional context - Third point, kept brief ### Sub-section Further detail belonging to a sub-topic goes here. ``` **3. Links, images, and blockquotes** ```markdown For further reading, see the [TSAP Manual of Style](/tsap/manual-of-style/). ![A descriptive caption for the image](assets/images/example.png "Optional tooltip") > "A quote from a relevant source or person." > — Attribution, *Source Title*, Year ``` **4. Tables and task lists** ```markdown | Name | Role | Since | |:-----------|:-----------|------:| | Example A | Editor | 2024 | | Example B | Researcher | 2025 | ## To Do - [x] Draft the article - [x] Add citations - [ ] Peer review - [ ] Publish ``` **5. Code blocks with syntax highlighting and footnotes** ```markdown The configuration file uses YAML front matter.[^1] --- layout: default title: "My Page" date: 2026-03-18 --- Inline references use backticks, such as `permalink` or `layout: default`. [^1]: YAML front matter is processed by Jekyll before the page is rendered. ``` ## Notes for TSAP Usage - Keep Markdown clean and minimal; avoid unnecessary HTML unless required for layout. - Prefer readability over visual styling in raw source files. - Use `---` primarily for front matter; avoid using it as a visual separator in content unless necessary. - Footnotes (`[^1]`) are preferred over inline parenthetical asides for references. - Follow the [TSAP Manual of Style](/tsap/manual-of-style/) for heading hierarchy, date format, and spelling conventions. - All dates in TSAP pages use the DMY format (e.g., 18 March 2026), except in direct quotations.