https://github.com/rubyworks/rdoc-shomen

RDoc generator for producing Shomen documentation
https://github.com/rubyworks/rdoc-shomen

Last synced: 12 months ago
JSON representation

RDoc generator for producing Shomen documentation

• Host: GitHub
• URL: https://github.com/rubyworks/rdoc-shomen
• Owner: rubyworks
• License: other
• Created: 2012-03-31T15:25:51.000Z (about 14 years ago)
• Default Branch: master
• Last Pushed: 2012-04-20T17:25:58.000Z (about 14 years ago)
• Last Synced: 2025-02-08T00:42:54.068Z (over 1 year ago)
• Language: Ruby
• Homepage: http://rubyworks.github.com/rdoc-shomen
• Size: 191 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rdoc
  • Changelog: HISTORY.rdoc
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
= Shomen RDoc Generator

{Homepage}[http://rubyworks.github.com/rdoc-shomen] /

{Report Issue}[http://github.com/rubyworks/rdoc-shomen/issues] /

{Source Code}[http://github.com/rubyworks/rdoc-shomen] /

{Mailing List}[http://google.groups.com/groups/rubyworks-mailinglist]

{}[http://travis-ci.org/rubyworks/rdoc-shomen]

== Description

This is the old-school Shomen generator for RDoc.

== Instruction

Use the shomen generator like any other RDoc generator.

  $ rdoc -f shomen -m README.rdoc lib [A-Z]*.*

The shomen document will be saved to the output directory (default `doc`)

as wither `doc.json` or as `-.json` if project metadata is

discoverable.

The generator supports a couple of special options:

* `--yaml` option will save the file to YAML format instead of JSON.

* `--source` will include full source code in script entries.

The `--source` option is not recommended for documentation that will

be served online as it will make the documation file rather large.

== Copyrights

Copyright (c) 2011 Rubyworks. All rights reserved.

RDoc Shomen is distributable in accordance with the *BSD-2-Clause* license.

See LICENSE.txt file for details.