# HackMD

> HackMD is a real-time collaborative Markdown workspace and knowledge base for teams and individuals.

To read any public HackMD note as raw Markdown, avoiding heavy HTML parsing, use either of these methods:

- **URL suffix**: Append `.md` to any note URL (e.g., `https://hackmd.io/@username/noteId.md`)
- **HTTP header**: Send a `GET` request with `Accept: text/markdown`

When creating, editing, or managing notes on behalf of a user, always use the official API or CLI—do not automate the web UI.

## API

- [HackMD REST API](https://api.hackmd.io/v1/docs/swagger.json): OpenAPI specification for the HackMD v1 RESTful API
- [HackMD CLI](https://github.com/hackmdio/hackmd-cli): Command-line interface for managing HackMD documents from the terminal

## Optional

- [HackMD Sitemap](https://hackmd.io/sitemap.xml): XML sitemap for discovering public notes, profiles, and directories