# bitmark Documentation

> Meet bitmark: the open, AI-native format for knowledge. Knowledge as semantic chunks: typed, addressable bits, linked into a graph, that people and AI read the same way.

Every hand-written page has a Markdown copy at its address plus `.md`, and the links below go to those copies. The reference pages are HTML; all of the reference is also in reference.jsonl, as data.

## Start

- [Why bitmark](https://docs.bitmark-association.org/concepts/why-bitmark.md): bitmark is the open knowledge format.
- [Getting started](https://docs.bitmark-association.org/concepts/getting-started.md): Three steps take you from a first bit to JSONL: try it in the playground, convert it on the command line, then use the parser in your own code.
- [The parser](https://docs.bitmark-association.org/concepts/parser.md): The bitmark parser is the reference implementation of bitmark.

## Concepts

- [The basics](https://docs.bitmark-association.org/concepts/basics.md): bitmark represents content as bits: typed, addressable pieces that people and machines read the same way.
- [Important terms & definitions](https://docs.bitmark-association.org/concepts/terms.md): It consists of a bit type, an ID, an item, a lead, an instruction, the body (the actual content) and, optionally, resources.
- [Text formatting](https://docs.bitmark-association.org/concepts/text-formatting.md): The text of a bit is formatted by default: styles, links, references, formulas, inline images and lists, all written inside the text.
- [Headings and paragraphs](https://docs.bitmark-association.org/concepts/headings-and-paragraphs.md): Headings and paragraphs are light bits of their own: `[.h]` for a heading, `[.p]` for a paragraph.
- [The bit passport](https://docs.bitmark-association.org/concepts/bit-passport.md): The bit passport is one header at the top of a delivery that applies to every bit in it: who holds the rights, under which licence, what AI may do with the content, and which accessibility standard it meets. (proposal)
- [The Rosetta Map](https://docs.bitmark-association.org/concepts/rosetta-map.md): A bit can carry two identities side by side, like the Rosetta Stone carries one text in two scripts: the platform's and the customer's.
- [Alias and diff books](https://docs.bitmark-association.org/concepts/alias-and-diff-books.md): An alias points to content instead of copying it; a diff adds a layer of changes on top of it.
- [Versions and updates](https://docs.bitmark-association.org/concepts/versions-and-updates.md): A reader that holds a document wants to fetch only what changed. (proposal)

## Use cases

- [Norms and standards](https://docs.bitmark-association.org/concepts/norms-and-standards.md): Standards are where bitmark's structure pays most.
- [Legal and citable content](https://docs.bitmark-association.org/concepts/legal-and-citable.md): Legal texts are cited to the paragraph.
- [Technical documentation](https://docs.bitmark-association.org/concepts/technical-documentation.md): Manuals, procedures and reference documentation are made of the same parts everywhere: headings, steps, warnings, figures and tables.
- [Learning](https://docs.bitmark-association.org/concepts/quizzes.md): bitmark grew up in learning content, and it still represents quizzes as bits in their own right: a cloze, a multiple choice or an essay sits next to the text it practises, with its solution and feedback, and can be cited and updated like any other bit.

## FAQ

- [bitmark and XML](https://docs.bitmark-association.org/concepts/bitmark-and-xml.md): bitmark does not compete with XML.

## About

- [The standard](https://docs.bitmark-association.org/concepts/the-standard.md): bitmark is an open standard.
- [Roadmap](https://docs.bitmark-association.org/concepts/roadmap.md): bitmark grows in the open.

## Reference

- [Bits](https://docs.bitmark-association.org/bits/): Content types — the building blocks of bitmark
- [Cards](https://docs.bitmark-association.org/cards/): Card structures for multi-part bits
- [Tags](https://docs.bitmark-association.org/tags/): Properties and markers used inside bits
- [Resources](https://docs.bitmark-association.org/resources/): Media types bits can attach or require
- [Marks](https://docs.bitmark-association.org/marks/): Inline text decorations and standalone nodes
- [The reference as JSON Lines](https://docs.bitmark-association.org/reference.jsonl): every bit, bit group, card, tag, resource and mark, one JSON object per line, after the docs' passport (licence and AI use)

## Optional

- [All the pages in one file](https://docs.bitmark-association.org/llms-full.txt): every hand-written page, then a one-line index of the reference
- [API documentation](https://getmorebrain.github.io/bitmark-parser/): the parser's JavaScript API
- [Playground](https://getmorebrain.github.io/bitmark-playground/): write bitmark and see its JSON