📦 This package has moved. It now lives in the markdown-magic-plugins monorepo at packages/directory-tree. This repository is archived; issues and contributions go to the monorepo.

Directory tree plugin

Add directory tree to markdown files via markdown-magic

Install

npm i markdown-magic markdown-magic-directory-tree --save-dev

Adding the plugin

See example.js for usage.

import path from 'path';
import { markdownMagic } from 'markdown-magic';
import DIRTREE from './index.js';

const config = {
  matchWord: 'AUTO-GENERATED-CONTENT',
  transforms: {
    DIRTREE,
  },
};

const markdownPath = path.join(import.meta.dirname, 'README.md');
await markdownMagic(markdownPath, config);

Usage in markdown

markdown-magic-directory-tree/
├── __fixtures__/
├── __snapshots__/
├── .github/
├── example.js
├── index.js
├── index.spec.js
├── package-lock.json
├── package.json
└── README.md

Options

• dir - process.cwd() by default
• ignore - ['.git', '.gitkeep', '.gitignore', 'node_modules'] by default
• depth - Infinity by default (how deep in the tree to traverse)
• onlyDirs - false by default (how mnuch t)