Markdown & VitePress Cheatsheet

A quick reference guide for writing documentation in this site.

1. Text Formatting

Style	Syntax	Example
Bold	**text**	Bold
Italic	*text*	Italic
Code	`text`	Code
~Strikethrough~	~text~	~Strikethrough~

2. Lists

Bulleted List

*   Item A
*   Item B
    *   Sub-item

Numbered List

1.  Step One
2.  Step Two

3. Code Blocks

Standard Block

```yaml
apiVersion: v1
kind: Pod
metadata:
  name: nginx

**With Line Highlighting** (Highlight lines 1 and 3)
```markdown
```yaml {1,3}
apiVersion: v1
kind: Pod
metadata:
  name: nginx

**With Filenames**
```markdown
```typescript [config.ts]
const name = "kubernetes";

## 4. Special Admonitions (Callouts)

VitePress has built-in "Custom Containers" for alerts. Use these sparingly for impact.

**Tip / Best Practice**
```markdown
::: tip Best Practice
Always set resource requests and limits.
:::

Best Practice

Always set resource requests and limits.

Info / Note

::: info Note
This feature requires Kubernetes v1.29+.
:::

Note

This feature requires Kubernetes v1.29+.

Warning

::: warning Deprecated
This API version is deprecated and will be removed in v1.30.
:::

Deprecated

This API version is deprecated and will be removed in v1.30.

Danger / Critical Alert

::: danger Critical
Do not delete the etcd data directory manually.
:::

Critical

Do not delete the etcd data directory manually.

5. Tables

| Component | Port | Protocol |
| :--- | :--- | :--- |
| API Server | 6443 | TCP |
| Etcd | 2379 | TCP |

Component	Port	Protocol
API Server	6443	TCP
Etcd	2379	TCP

6. Internal Linking

To link to another file, use the relative path or the clean URL.

• [Go to Architecture](../architecture/01-Core-Architecture.md)
• [See Troubleshooting](../tshooting/01-Pod-Crashloop.md)