{"id":22981057,"url":"https://github.com/rubyworks/rubyfaux","last_synced_at":"2025-04-02T09:42:09.671Z","repository":{"id":66244233,"uuid":"2500218","full_name":"rubyworks/rubyfaux","owner":"rubyworks","description":"Shomen HTML browser with Old-School Ruby Style ||","archived":false,"fork":false,"pushed_at":"2015-01-18T09:59:30.000Z","size":472,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-08T00:42:53.114Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://rubyworks.github.io/rubyfaux/?doc=doc.json","language":"JavaScript","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":null,"contributing":null,"funding":null,"license":"COPYING.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2011-10-02T17:08:37.000Z","updated_at":"2022-11-15T10:14:38.000Z","dependencies_parsed_at":"2023-02-20T02:31:07.995Z","dependency_job_id":null,"html_url":"https://github.com/rubyworks/rubyfaux","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Frubyfaux","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Frubyfaux/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Frubyfaux/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Frubyfaux/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rubyworks","download_url":"https://codeload.github.com/rubyworks/rubyfaux/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246793065,"owners_count":20834922,"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:51.841Z","updated_at":"2025-04-02T09:42:09.652Z","avatar_url":"https://github.com/rubyworks.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Rubyfaux\n\n[Website](http://rubyworks.github.com/rubyfaux) \u0026middot;\n[Development](http://github.com/rubyworks/rubyfaux)\n\n\n## Welcome\n\nRubyfaux is a Shomen-based documentation browser with an old-school\nruby-lang.org style.\n\n\n## Features\n\n* Old-school ruby-lang.org style gives documentation an offical look-and-feel.\n* Quicksearch sidebar makes it easy to locate classes and methods.\n* Built on JQuery, JQuery Templates and other well supported Javascript tools.\n\n\n## How To Use\n\nGenerate a shomen `.json` file for you project.\n\n    $ cd ..\n    $ shomen rdoc \u003e site/foo-1.0.0.json\n\nSee Shomen project to learn more about this.\n\nTo locally view your documentation, clone this repo to your project's\nwebite directory (or `gh-pages` branch if you are crazy like that).\n\n    $ cd myproject\n    $ git clone http://rubyworks.github.com/rubyfaux.git site\n    $ cd site\n    $ rm -rf .git\n\nBy default it will look for `doc.json` so you can link that to \nthe latest documentation file.\n\n    $ ln -s foo-1.0.0.json doc.json\n\nNow fire up local directory webserver. The `shomen` command provides\none (must have `sinatra` installed):\n\n    $ shomen server\n\nYou can also view the files directly if your browser supports local\najax calls (Firefox works. Chrome? Not so much).\n\n    $ firefox index.html\n\nNow then, customize that template to your little hearts desire!\n\nTo view you documentation remotely, firs publish you Shomen .json\nfile, presumably to your website, but it can be anywhere on the\ninternet that will accept loading via ajax.\n\nNow navigate over to the Rubyfaux site setting the `doc` property\nin the URL to the location of the file, e.g.\n\n    http://rubyworks.github.com/rubyfaux?doc=http://myorg.github.com/myapp/myapp-1.0.0.json\n\nAnd there you are.\n\nNote that if the documented project is large so too will be the Shomen `.json` file.\nIn which case it take a moment for the browser to load the file. For large projects\nas such it is a good idea to divide documentation into a set of smaller files, rather \nthan one big file.\n\n\n## Legalease\n\nCopyright (c) 2011 Thomas Sawyer\n\nAvailable according to the terms of the *BSD-2-Clause* license.\n\nExternal libraries used:\n\n* [jQuery](http://jquery.org)\n* [jQuery-tmpl](http://github.com/jquery/jquery-tmpl)\n* [Quicksearch](http://github.com/riklomas/quicksearch)\n* [Highlight](http://github.com/isagalaev/highlight.js)\n* [Showdown](http://github.com/coreyti/showdown)\n* [Rundown](http://github.com/rubyworks/rundown)\n* [Keymaster](http://github.com/madrobby/keymaster)\n* [Mousewheel](http://plugins.jquery.com/project/mousewheel)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubyworks%2Frubyfaux","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frubyworks%2Frubyfaux","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubyworks%2Frubyfaux/lists"}