{"id":22980959,"url":"https://github.com/rubyworks/shomen-model","last_synced_at":"2025-04-02T09:42:01.477Z","repository":{"id":997135,"uuid":"807663","full_name":"rubyworks/shomen-model","owner":"rubyworks","description":"Ruby Model API for Shomen Documentation","archived":false,"fork":false,"pushed_at":"2012-06-18T23:07:31.000Z","size":516,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-09T05:45:58.186Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://rubyworks.github.com/shomen","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rubyworks.png","metadata":{"files":{"readme":"README.md","changelog":"HISTORY.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2010-07-30T15:40:44.000Z","updated_at":"2014-03-04T18:25:21.000Z","dependencies_parsed_at":"2022-08-16T11:45:22.536Z","dependency_job_id":null,"html_url":"https://github.com/rubyworks/shomen-model","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fshomen-model","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fshomen-model/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fshomen-model/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fshomen-model/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rubyworks","download_url":"https://codeload.github.com/rubyworks/shomen-model/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246793010,"owners_count":20834921,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-15T01:46:18.032Z","updated_at":"2025-04-02T09:42:01.447Z","avatar_url":"https://github.com/rubyworks.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Shomen\n\n[Website](http://rubyworks.github.com/shomen) /\n[User Manual](http://github.com/rubyworks/shomen/wiki) /\n[Development](http://github.com/rubyworks/shomen) /\n[Mailing List](http://groups.google.com/groups/rubyworks-mailinglist) /\n[IRC Channel](http://chat.us.freenode.net/rubyworks)\n\n\n## Description\n\nShomen is an intermediary documentation model designed for documenting\nobject-oriented programming languages, particularly Ruby. The specification\nis a flat mapping, without internal referencing, suitable for storage in both\nYAML and JSON formats.\n\n\n## Why?\n\nBy using a standard intermediary format, documentation parsers need only concern\nthemselves with a single output target. And documentation templates in turn only\nneed to concern themselves with a single input format regardless of the parsing\nsystem that was used to generate it.\n\n\n## Features\n\n* Update a single portable file to update documentation.\n* Site disc footprint is extra small thanks to CDNs.\n* Personalize site design to best fit your project.\n* Test drive others customizations with your own remote docs!\n\n\n## Instructions\n\nTo learn about Shomen in detail please visit:\n\n* [User Manual](http://github.com/rubyworks/shomen/wiki)\n* [API Documentation](http://rubyworks.github.com/shomen)\n\nOverall usage consists of generating a Shomen documentation file for a\nproject. Typical usage looks something like:\n\n  $ shomen -R -r README.rdoc lib - [A-Z]*.* \u003e doc.json\n\nNext you want to pair up your doc.json file with a viewer. Currently that means\nusing one of the following:\n\n* [HyperVisor](http://github.com/rubyworks/hypervisor)\n* [Rebecca](http://github.com/rubyworks/rebecca)\n* [Rubyfaux](http://github.com/rubyworks/rubyfaux)\n\nYou can copy any of those repos to your website (e.g. site/) and run with it.\nIf you want to try it out locally, we recommend using [thin](http://code.macournoyer.com/thin/)\nto view the site.\n\n    $ cd site\n    $ thin start -A file\n\nIf you can't use thin, Shomen provides a simplistic rack-based static server\nwhich can be used.\n\n    $ cd site\n    $ shomen-server\n\nViewers don't necessarily need to be copied. All three above can take\na `doc={url-to-shomen-json-file}` http parameter and server up the docs remotely.\nYou just need to publish your `doc.json` file to a publicly accessible URL.\nNote, I recommend that in this case you name the file more specifically,\ne.g. `myapp-1.0.0.json`.\n\nSee the viewer projects for more information.\n\n\n## Copying\n\nCopyright (c) 2010 Rubyworks\n\nShomen is distributed under the terms of the **BSD-2-Clause** license.\n\nSee License.txt for license details.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubyworks%2Fshomen-model","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frubyworks%2Fshomen-model","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubyworks%2Fshomen-model/lists"}