{"repo":"target/markdown-inject","free":true,"listed":false,"github":"https://github.com/target/markdown-inject","clone":"git clone https://github.com/target/markdown-inject.git","description":"Add file or command output to markdown documents.","language":"TypeScript","stars":12,"topics":["markdown","cli","documentation-generator"],"license":"Apache-2.0","category":"cli-tools","readme_excerpt":"markdown-inject Add file or command output to markdown documents. Installation markdown-inject is written in TypeScript and distributed as a node module on the npm ecosystem. It exposes a bin executable, making it a command line offering. Download and invoke in one command: Local npm installation: or with Yarn: Optionally, wire up markdown-inject to a git pre-commit hook tool like husky to automatically update markdown injection as part of your workflow. Usage Note: markdown-inject takes no action during pull request builds in CI. bash Usage: markdown-inject [options] Examples: $ npx markdown-inject -a $ npx markdown-inject 'README.md' $ npx markdown-inject './ / .{md,mdx}' Add file or command output to markdown documents. Options: -v, --version output the version number -a, --all applies a globPattern of './ / .md' (default: false) -b, --block-prefix specifies the prefix for START and END HTML comment blocks (default: \"CODEBLOCK\") -n, --no-follow-symbolic-links prevents globs from following symlinks -q, --quiet emits no console log statements (default: false) -e, --no-system-environment prevents \"command\"s from receiving system environment -h, --help display help for command markdown-inject expands a given glob for markdown files. Then it discovers the below CODEBLOCK HTML or MDX (as shown in CONTRIBUTING.mdx) comments within each markdown file, performs the appropriate action (in this case, reading another local file), and writes content back into the markdown file: Output ","default_branch":null,"files":null,"tree":[],"storefront":"/r/target","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/target/markdown-inject/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}