https://github.com/itspriddle/rake-tomdoc
Adds `rake tomdoc` to generate documentation for publishing to GitHub Pages
https://github.com/itspriddle/rake-tomdoc
Last synced: 11 months ago
JSON representation
Adds `rake tomdoc` to generate documentation for publishing to GitHub Pages
- Host: GitHub
- URL: https://github.com/itspriddle/rake-tomdoc
- Owner: itspriddle
- License: other
- Created: 2013-07-10T19:03:53.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2018-02-08T15:26:27.000Z (over 8 years ago)
- Last Synced: 2025-03-06T17:17:33.589Z (over 1 year ago)
- Language: Ruby
- Homepage:
- Size: 8.79 KB
- Stars: 1
- Watchers: 12
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.markdown
- License: LICENSE
Awesome Lists containing this project
README
# rake-tomdoc
Adds `rake tomdoc` to generate documentation for publishing to GitHub Pages.
## Setup
Add this gem as a development dependency to your projects Gemfile or gemspec:
```ruby
gem 'rake-tomdoc', group: :development
Gem::Specification.new do |s|
...
s.add_development_dependency 'rake-tomdoc'
end
```
Create a gh-pages branch in your project. Make sure you have committed any
changes and your repository contains no untracked files!
```
$ git checkout --orphan gh-pages
$ git rm -rf .
$ git commit --allow-empty -m "Created gh-pages branch"
$ git checkout -
```
Require the gem in your `Rakefile`:
```ruby
require 'rake-tomdoc'
```
## Usage
When you are ready to publish new documentation:
```
$ rake tomdoc [--trace]
$ git commit -am "Updating documentation"
$ git push origin gh-pages
$ git checkout -
```
## Note on Patches/Pull Requests
* Fork the project.
* Make your feature addition or bug fix.
* Commit, do not bump version.
* Send me a pull request. Bonus points for topic branches.
## Copyright
Copyright (c) 2018 Joshua Priddle. See LICENSE for details.