https://github.com/optimizely/markdown-helpers
A Ruby gem for helping with documentation in markdown
https://github.com/optimizely/markdown-helpers
Last synced: 10 months ago
JSON representation
A Ruby gem for helping with documentation in markdown
- Host: GitHub
- URL: https://github.com/optimizely/markdown-helpers
- Owner: optimizely
- License: mit
- Archived: true
- Created: 2015-11-03T02:01:53.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-11-25T21:38:23.000Z (over 10 years ago)
- Last Synced: 2025-03-01T12:17:18.337Z (about 1 year ago)
- Language: Ruby
- Size: 12.7 KB
- Stars: 0
- Watchers: 133
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#Markdown Helper
## Description
'Markdown helpers' is a gem for helping write docs in your github repo using markdown.
It command line helpers fo:
- building an index to link to a documentation directory tree
- finding broken local and external links in your docs
## Setup
Install the gem:
```
gem install 'markdown-helpers
```
Or if you're using bundler add this to your Gemfile:
```
gem 'markdown-helpers'
```
## Usage
There are two subcommands for the `markdownh` executable.
- `generate_index` for generating a link index to your documentation files
- `check_links` for finding broken links in your docs
More info is found at:
- [Valid Link Checker](./docs/check_links.md)
- [Documentation Index Generator](./docs/generate_index.md)
Copyright:: 2015, Optimizely, Inc.
All rights reserved and are property of Optimizely, Inc.