Bullet Styles & Nesting

Unordered Markdown lists (ul) are converted by @m2d/list into multi-level Word bulleted paragraphs, with distinct glyphs assigned to each nesting tier.

Default Bullet Glyph HierarchyCopy Anchor Link

When nesting unordered lists in Markdown:

- Level 0 Item
  - Level 1 Item
    - Level 2 Item
      - Level 3 Item

@m2d/list assigns a distinct bullet character to each indentation level:

Customizing Bullet CharactersCopy Anchor Link

You can supply your own array of bullet glyphs:

import { listPlugin } from "@m2d/list";

const plugin = listPlugin({
  bullets: ["—", "•", "›", "·"],
});

Using Word's Built-In Bullet Styles (defaultBullets)Copy Anchor Link

If your target document template relies on Microsoft Word's own default bullet formatting rather than custom OpenXML numbering definitions, set defaultBullets: true:

import { listPlugin } from "@m2d/list";

const plugin = listPlugin({
  defaultBullets: true,
});

When enabled, @m2d/list delegates bullet rendering to Word's native paragraph bullet presets without embedding custom numbering definitions.

Deep Customization with bulletLevelsCopy Anchor Link

For corporate brand templates requiring exact indentations, custom fonts (e.g. Wingdings, Symbol), or specific hanging indents for bullets, provide an explicit bulletLevels array conforming to docx.ILevelsOptions[]:

import { listPlugin } from "@m2d/list";
import { AlignmentType, LevelFormat, convertInchesToTwip } from "docx";

const plugin = listPlugin({
  bulletLevels: [
    {
      level: 0,
      format: LevelFormat.BULLET,
      text: "❖",
      alignment: AlignmentType.START,
      style: {
        paragraph: {
          indent: { left: convertInchesToTwip(0.35) },
        },
      },
    },
  ],
});