0.01
No commit activity in last 3 years
No release in over 3 years
YARD plugin to build a sitemap.xml for generated HTML documentation.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies
 Project Readme

YARD Sitemap

A YARD 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