Skip to content

Latest commit

 

History

History
81 lines (59 loc) · 1.94 KB

README.md

File metadata and controls

81 lines (59 loc) · 1.94 KB
Raw

LINK COMMAND

  • md-hopper link # short l
  • mdhopper link # short l
  • mdhop link # short l

Set Config in md File

ROOT FILE

<!-- MD_HOPPER: CONFIG:
skip-hidden: true # optional: default true (ex: ignore .git, .idea, etc)
include: src/**/*,libs/**/*.ts # optional: default empty (all files)
exclude: dist/**/* # optional: default empty (only node_modules)
filenames: README.md,CHANGE_LOG.md # optional: default README.md
-->

<!-- MD_HOPPER: OUTPUT: README.md --> # optional (default: README.md) ex: README_MAIN.md

OTHERS

child file setting

set file id and link name

<!-- MD_HOPPER: ID: hoge -->
<!-- MD_HOPPER: LOCK: true --> # not generate when it true, default false
<!-- MD_HOPPER: TITLE: LINK COMMAND -->

or

<!-- MD_HOPPER: ID: hoge -->

# GENERATE COMMAND

set specific target md position

<!-- MD_HOPPER: LINK_NEXT_LINE:
id: hoge # required
inline: false  # optional: default false
-->

all / children / grandChild / parallel depth link list

<!-- MD_HOPPER: BEGIN_LINKS:
all: true # optional: default false
linked: false # optional: default false
child: true # optional: default false
grandChild: true # optional: default false
parallel: true # optional: default false
-->

<!-- MD_HOPPER: END_LINKS: -->

Command Options

  .option('-sh --skip-hidden <boolean>', 'skip read hidden dir, default: true')
  .option('-incl, --include <strings>', 'include dirs, default: [] (all files)')
  .option('-excl, --exclude <strings>', 'ignore dirs, default: node_modules only')
  .option('-f, --filenames <strings>', 'filenames, default: README.md only')
  .option('-o, --output <filename>', 'output filename. default: README.md (replace)')
  .option('-i, --input <filename>', 'target root filename, default: README.md')