BlockSuite API Documentation / @blocksuite/blocks / MarkdownAdapter

Class: MarkdownAdapter

Extends

• BaseAdapter<Markdown>

Constructors

new MarkdownAdapter()

new MarkdownAdapter(job): MarkdownAdapter

Parameters

• job: Job

Returns

MarkdownAdapter

Inherited from

BaseAdapter.constructor

Source

packages/framework/store/dist/adapter/base.d.ts:46

Properties

configs

protected configs: Map<string, unknown>

Inherited from

BaseAdapter.configs

Source

packages/framework/store/dist/adapter/base.d.ts:44

---

job

job: Job

Inherited from

BaseAdapter.job

Source

packages/framework/store/dist/adapter/base.d.ts:45

Methods

_astToMarkdown()

private _astToMarkdown(ast): string

Parameters

• ast: Root

Returns

string

Source

packages/blocks/src/_common/adapters/markdown.ts:864

---

_deltaToMdAST()

private _deltaToMdAST(deltas, depth): (Text | Link | Strong | Delete | Emphasis | InlineCode)[]

Parameters

• deltas: DeltaInsert<AffineTextAttributes>[]

• depth: number= 0

Returns

(Text | Link | Strong | Delete | Emphasis | InlineCode)[]

Source

packages/blocks/src/_common/adapters/markdown.ts:878

---

_markdownToAst()

private _markdownToAst(markdown): Root

Parameters

• markdown: string

Returns

Root

Source

packages/blocks/src/_common/adapters/markdown.ts:874

---

_mdastToDelta()

private _mdastToDelta(ast): DeltaInsert[]

Parameters

• ast: MarkdownAST

Returns

DeltaInsert[]

Source

packages/blocks/src/_common/adapters/markdown.ts:945

---

_traverseMarkdown()

private _traverseMarkdown(markdown, snapshot, assets?): Promise<BlockSnapshot>

Parameters

• markdown: MarkdownAST

• snapshot: BlockSnapshot

• assets?: AssetsManager

Returns

Promise<BlockSnapshot>

Source

packages/blocks/src/_common/adapters/markdown.ts:522

---

_traverseSnapshot()

private _traverseSnapshot(snapshot, markdown, assets?): Promise<object>

Parameters

• snapshot: BlockSnapshot

• markdown: MarkdownAST

• assets?: AssetsManager

Returns

Promise<object>

assetsIds

assetsIds: string[]

ast

ast: Root

Source

packages/blocks/src/_common/adapters/markdown.ts:59

---

applyConfigs()

applyConfigs(configs): void

Parameters

• configs: Map<string, unknown>

Returns

void

Inherited from

BaseAdapter.applyConfigs

Source

packages/framework/store/dist/adapter/base.d.ts:59

---

fromBlock()

fromBlock(mode): Promise<FromBlockSnapshotResult<string>>

Parameters

• mode: DraftModel

Returns

Promise<FromBlockSnapshotResult<string>>

Inherited from

BaseAdapter.fromBlock

Source

packages/framework/store/dist/adapter/base.d.ts:55

---

fromBlockSnapshot()

fromBlockSnapshot(__namedParameters): Promise<FromBlockSnapshotResult<string>>

Parameters

• __namedParameters: FromBlockSnapshotPayload

Returns

Promise<FromBlockSnapshotResult<string>>

Overrides

BaseAdapter.fromBlockSnapshot

Source

packages/blocks/src/_common/adapters/markdown.ts:1010

---

fromDoc()

fromDoc(doc): Promise<FromDocSnapshotResult<string>>

Parameters

• doc: Doc

Returns

Promise<FromDocSnapshotResult<string>>

Inherited from

BaseAdapter.fromDoc

Source

packages/framework/store/dist/adapter/base.d.ts:53

---

fromDocSnapshot()

fromDocSnapshot(__namedParameters): Promise<FromDocSnapshotResult<string>>

Parameters

• __namedParameters: FromDocSnapshotPayload

Returns

Promise<FromDocSnapshotResult<string>>

Overrides

BaseAdapter.fromDocSnapshot

Source

packages/blocks/src/_common/adapters/markdown.ts:994

---

fromSlice()

fromSlice(slice): Promise<FromSliceSnapshotResult<string>>

Parameters

• slice: Slice

Returns

Promise<FromSliceSnapshotResult<string>>

Inherited from

BaseAdapter.fromSlice

Source

packages/framework/store/dist/adapter/base.d.ts:57

---

fromSliceSnapshot()

fromSliceSnapshot(__namedParameters): Promise<FromSliceSnapshotResult<string>>

Parameters

• __namedParameters: FromSliceSnapshotPayload

Returns

Promise<FromSliceSnapshotResult<string>>

Overrides

BaseAdapter.fromSliceSnapshot

Source

packages/blocks/src/_common/adapters/markdown.ts:1029

---

toBlock()

toBlock(payload, doc, parent?, index?): Promise<BlockModel<object>>

Parameters

• payload: ToBlockSnapshotPayload<string>

• doc: Doc

• parent?: string

• index?: number

Returns

Promise<BlockModel<object>>

Inherited from

BaseAdapter.toBlock

Source

packages/framework/store/dist/adapter/base.d.ts:56

---

toBlockSnapshot()

toBlockSnapshot(payload): Promise<BlockSnapshot>

Parameters

• payload: ToBlockSnapshotPayload<string>

Returns

Promise<BlockSnapshot>

Overrides

BaseAdapter.toBlockSnapshot

Source

packages/blocks/src/_common/adapters/markdown.ts:1115

---

toDoc()

toDoc(payload): Promise<Doc>

Parameters

• payload: ToDocSnapshotPayload<string>

Returns

Promise<Doc>

Inherited from

BaseAdapter.toDoc

Source

packages/framework/store/dist/adapter/base.d.ts:54

---

toDocSnapshot()

toDocSnapshot(payload): Promise<DocSnapshot>

Parameters

• payload: ToDocSnapshotPayload<string>

Returns

Promise<DocSnapshot>

Overrides

BaseAdapter.toDocSnapshot

Source

packages/blocks/src/_common/adapters/markdown.ts:1056

---

toSlice()

toSlice(payload, doc, parent?, index?): Promise<undefined | Slice>

Parameters

• payload: ToSliceSnapshotPayload<string>

• doc: Doc

• parent?: string

• index?: number

Returns

Promise<undefined | Slice>

Inherited from

BaseAdapter.toSlice

Source

packages/framework/store/dist/adapter/base.d.ts:58

---

toSliceSnapshot()

toSliceSnapshot(payload): Promise<null | SliceSnapshot>

Parameters

• payload: MarkdownToSliceSnapshotPayload

Returns

Promise<null | SliceSnapshot>

Overrides

BaseAdapter.toSliceSnapshot

Source

packages/blocks/src/_common/adapters/markdown.ts:1139