get-md-docs
v1.0.2
Published
Retrieve all of the Markdown docs (including README) from a repository.
Downloads
2
Readme
get-md-docs
Retrieve all of the Markdown docs (including README) from a repository.
Usage
# Install
npm i -g get-md-docs
# Run
get-docs --org your-org --repo your-repo --dest ./folder-for-docs
Features
- Recursive traversal of a target repository; leave no Markdown file un-found!
- Preserves directory structure of located documents (no need to rework your internal links between docs)
- Language-and-framework agnostic; doesn't read any metadata from package.json, Gemfile, or any other manifests specific to a community, framework, or language.
Why?
I needed to rip Markdown docs from a bunch of repositories for use in a Jekyll-based page; if you find another use for it, that's awesome!