https://github.com/rubyworks/shomen-model
Ruby Model API for Shomen Documentation
https://github.com/rubyworks/shomen-model
Last synced: 11 months ago
JSON representation
Ruby Model API for Shomen Documentation
- Host: GitHub
- URL: https://github.com/rubyworks/shomen-model
- Owner: rubyworks
- License: other
- Created: 2010-07-30T15:40:44.000Z (over 15 years ago)
- Default Branch: master
- Last Pushed: 2012-06-18T23:07:31.000Z (over 13 years ago)
- Last Synced: 2025-03-09T05:45:58.186Z (11 months ago)
- Language: Ruby
- Homepage: http://rubyworks.github.com/shomen
- Size: 504 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Shomen
[Website](http://rubyworks.github.com/shomen) /
[User Manual](http://github.com/rubyworks/shomen/wiki) /
[Development](http://github.com/rubyworks/shomen) /
[Mailing List](http://groups.google.com/groups/rubyworks-mailinglist) /
[IRC Channel](http://chat.us.freenode.net/rubyworks)
## Description
Shomen is an intermediary documentation model designed for documenting
object-oriented programming languages, particularly Ruby. The specification
is a flat mapping, without internal referencing, suitable for storage in both
YAML and JSON formats.
## Why?
By using a standard intermediary format, documentation parsers need only concern
themselves with a single output target. And documentation templates in turn only
need to concern themselves with a single input format regardless of the parsing
system that was used to generate it.
## Features
* Update a single portable file to update documentation.
* Site disc footprint is extra small thanks to CDNs.
* Personalize site design to best fit your project.
* Test drive others customizations with your own remote docs!
## Instructions
To learn about Shomen in detail please visit:
* [User Manual](http://github.com/rubyworks/shomen/wiki)
* [API Documentation](http://rubyworks.github.com/shomen)
Overall usage consists of generating a Shomen documentation file for a
project. Typical usage looks something like:
$ shomen -R -r README.rdoc lib - [A-Z]*.* > doc.json
Next you want to pair up your doc.json file with a viewer. Currently that means
using one of the following:
* [HyperVisor](http://github.com/rubyworks/hypervisor)
* [Rebecca](http://github.com/rubyworks/rebecca)
* [Rubyfaux](http://github.com/rubyworks/rubyfaux)
You can copy any of those repos to your website (e.g. site/) and run with it.
If you want to try it out locally, we recommend using [thin](http://code.macournoyer.com/thin/)
to view the site.
$ cd site
$ thin start -A file
If you can't use thin, Shomen provides a simplistic rack-based static server
which can be used.
$ cd site
$ shomen-server
Viewers don't necessarily need to be copied. All three above can take
a `doc={url-to-shomen-json-file}` http parameter and server up the docs remotely.
You just need to publish your `doc.json` file to a publicly accessible URL.
Note, I recommend that in this case you name the file more specifically,
e.g. `myapp-1.0.0.json`.
See the viewer projects for more information.
## Copying
Copyright (c) 2010 Rubyworks
Shomen is distributed under the terms of the **BSD-2-Clause** license.
See License.txt for license details.