Obsidian Markdown

---
title: Project Overview
tags:
  - project
  - active
status: in-progress
priority: high
created: 2025-03-06
---

## Project Links

Related to [[Team Members]] and
[[Architecture Decisions]].

See [[Meeting Notes#Action Items]]
for tasks from the last meeting.

Contact [[John Smith|John]] for
backend questions.

## Embedded Content

![[project-diagram.png]]

![[Requirements Document#Summary]]

> [!warning] Deadline
> This project must ship by Q2.
> Contact the PM for extensions.

> [!tip] Quick Start
> Run `npm install` then
> `npm run dev` to start.

> [!note]- Additional Context
> This section is collapsed
> by default. Click to expand.

---
title: API Integration Guide
tags:
  - documentation
  - api
author: Engineering Team
version: 2.1
reviewed: true
---

## Authentication

See [[Auth Service]] for the
token management implementation.

![[Auth Service#Token Flow]]

> [!important] Rate Limits
> API calls are limited to
> 100 requests per minute.
> See [[Rate Limiting]] for
> configuration details.

## Architecture

```mermaid
sequenceDiagram
    Client->>API: POST /auth/token
    API->>Auth: Validate credentials
    Auth-->>API: JWT token
    API-->>Client: 200 + token
    Client->>API: GET /data
    Note over Client,API: Bearer token
    API-->>Client: 200 + data

### Advanced Tips

Use heading anchors in wikilinks to link directly to specific sections within long notes. Create templates with predefined frontmatter properties to ensure consistent metadata across note types. Use callout type aliases to create custom callout styles that match your documentation conventions.

## When to Use It?

### Use Cases

Build a technical documentation vault with cross-referenced API guides, architecture diagrams, and embedded code examples. Create a research knowledge base with literature notes linked to source materials and annotated with callout summaries. Implement a project wiki with embedded meeting notes, decision records, and Mermaid diagrams for process flows.

### Related Topics

Obsidian vault authoring, Markdown syntax, personal knowledge management, Zettelkasten method, and note linking.

## Important Notes

### Requirements

Obsidian desktop or mobile application for rendering extended Markdown features. Notes stored as plain Markdown files with .md extension in a vault folder. Mermaid plugin enabled for diagram rendering support.

### Usage Recommendations

**Do:** use wikilinks over standard Markdown links for internal vault references to enable bidirectional linking. Add frontmatter properties consistently across notes for effective filtering in search and base views. Use embed syntax to reference shared content from a single source note.

**Don't:** create circular embeds where Note A embeds Note B and Note B embeds Note A, which causes rendering issues. Overuse callouts for regular content that does not need special visual emphasis. Store binary files directly in the vault when external links to cloud storage are more efficient.

### Limitations

Obsidian-flavored Markdown features like wikilinks and callouts are not rendered by standard Markdown processors. Embeds of large notes can slow down rendering in the editor. Some callout types and styling depend on the active Obsidian theme.