https://github.com/lsegal/yard-sitemap

A YARD plugin to build a sitemap.xml for generated HTML documentation.
https://github.com/lsegal/yard-sitemap

Last synced: 3 months ago
JSON representation

A YARD plugin to build a sitemap.xml for generated HTML documentation.

• Host: GitHub
• URL: https://github.com/lsegal/yard-sitemap
• Owner: lsegal
• License: mit
• Created: 2013-09-14T07:53:05.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2013-09-16T18:16:33.000Z (over 11 years ago)
• Last Synced: 2024-09-19T05:44:52.640Z (4 months ago)
• Language: Ruby
• Size: 113 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# YARD Sitemap

A [YARD][1] plugin to build a sitemap.xml for generated HTML documentation.

## Installation

Add this line to your application's Gemfile:

    gem 'yard-sitemap'

And then execute:

    bundle

Or install it yourself as:

    gem install yard-sitemap

## Usage

Simply activate the plugin when running YARD, setting the SITEMAP_BASEURL

environment variable with the base URL of your site:

    SITEMAP_BASEURL=http://example.org yard doc --plugin sitemap

[1]: http://yardoc.org