JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 8169
  • Score
    100M100P100Q119355F
  • License MIT

Command line tool to inject files into markdown files.

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (inject-markdown) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    Inject Markdown

    Inject files into a Markdown file.

    Justification

    Sometimes it is necessary to assemble content into a static markdown file like README.md. Manually copying and pasting content leads to duplication making it difficult to keep things in sync.

    Usage

    Use HTML comments to mark where content will be injected.

    <!--- @@inject: fixtures/sample-src.md --->
    npx inject-markdown README.md

    --help

    npx inject-markdown --help

    Result

    Usage: inject-markdown [options] <files...>
    
    Inject file content into markdown files.
    
    Arguments:
      files                 Files to scan for injected content.
    
    Options:
      --no-must-find-files  No error if files are not found.
      --output-dir <dir>    Output Directory
      --cwd <dir>           Current Directory
      --clean               Remove the injected content.
      --verbose             Verbose output.
      --silent              Only output errors.
      --color               Force color.
      --no-color            Do not use color.
      -V, --version         output the version number
      -h, --help            display help for command