Code Monkey home page Code Monkey logo

markdown-magic-directory-tree's Introduction

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.

const fs = require('fs');
const path = require('path');
const markdownMagic = require('markdown-magic');

const config = {
  transforms: {
    DIRTREE: require('./index.js'),
  }
}

const markdownPath = path.join(__dirname, 'README.md');
markdownMagic(markdownPath, config);

Usage in markdown

markdown-magic-directory-tree/
├── .npmrc
├── example.js
├── index.js
├── package.json
├── README.md
└── yarn.lock

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)

markdown-magic-directory-tree's People

Contributors

danethurber avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.