Create invisible navigation markers for cross-references and document jumping. Bookmarks are essential for long documents, enabling table of contents, cross-references, and quick navigation. Fully compatible with Word bookmarks.

​
OOXML Structure

<w:bookmarkStart w:id="0" w:name="introduction"/>
  <w:r>
    <w:t>Content between bookmark markers</w:t>
  </w:r>
<w:bookmarkEnd w:id="0"/>

​
Why you’d use this

  • Table of Contents - Create clickable navigation in long documents
  • Cross-references - Link to specific sections (“See Section 3.2”)
  • Legal documents - Reference clauses and appendices
  • Technical docs - Jump between related topics
  • Report navigation - Quick access to executive summary, findings, conclusions

​
Common bookmark patterns

  • Header bookmarks - Place at each major section
  • Figure references - “See Figure 3” with bookmark links
  • Appendix links - Navigate to supporting materials
  • Index entries - Create document indices with bookmark targets

​
Options

Configure the extension behavior:
​
htmlAttributes
Object
HTML attributes for the bookmark element
Usage: 
BookmarkStart.configure({
  resizable: false,
  cellMinWidth: 50
})

​
Attributes

​
name
string
Bookmark name for cross-references and navigation
​
id
string
Unique identifier for the bookmark

​
Commands

​
insertBookmark

Insert a bookmark at the current position
Bookmarks are invisible markers for navigation and cross-references
// Insert a named bookmark
insertBookmark({ name: 'chapter1' })

// Insert with ID
insertBookmark({ name: 'introduction', id: 'intro-001' })
Parameters:
​
config
BookmarkConfig
required
See BookmarkConfig type definition

​
goToBookmark

Navigate to a bookmark by name
Scrolls the document to the bookmark position
goToBookmark('chapter1')
Parameters:
​
name
string
required
Bookmark name to navigate to

​
Types

​
BookmarkConfig

Bookmark configuration