https://github.com/trhodeos/yard-ghpages
Easily push yard docs to Github Pages
https://github.com/trhodeos/yard-ghpages
gh-pages github-page rake yard yard-docs
Last synced: about 2 months ago
JSON representation
Easily push yard docs to Github Pages
- Host: GitHub
- URL: https://github.com/trhodeos/yard-ghpages
- Owner: trhodeos
- License: mit
- Created: 2013-04-10T01:02:40.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2021-03-14T21:47:35.000Z (about 5 years ago)
- Last Synced: 2026-01-14T00:20:08.175Z (4 months ago)
- Topics: gh-pages, github-page, rake, yard, yard-docs
- Language: Ruby
- Homepage:
- Size: 81.1 KB
- Stars: 13
- Watchers: 2
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Yard::GHPages
A simple set of Rake tasks that generates Yard docs and publishes them to github
pages.
## Installation
Add this line to your application's Gemfile:
gem 'yard-ghpages'
And then execute:
$ bundle
Or install it yourself as:
$ gem install yard-ghpages
## Usage
This gem exposes two new rake tasks: `yard:build` and `yard:publish`.
To use this gem, install in the `Rakefile`.
```
require 'yard-ghpages'
Yard::GHPages::Tasks.install_tasks
```
Build the yard docs.
```
rake yard:build
```
Commit the changes.
```
git commit -am 'Update yard docs'
```
Publish the docs to github pages.
```
rake yard:publish
```
Easy as that!
## Optional Configuration
Include a file called .yard-gh-pages.yml in the root of your project.
Options:
- source_branch (default: 'master')
- Branch that should be used to pull the latest directory of generated YARD files
- source_directory (default: 'docs')
- Directory within the source_branch that contains the generated YARD files
- destination_branch (default: 'gh-pages')
- Branch within github where the YARD files should be pushed. 'gh-pages' is also the default branch used by Github.
Example file:
```yaml
source_branch: 'master'
source_directory: 'docs'
destination_branch: 'gh-pages'
```
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request