{"id":13558305,"url":"https://github.com/rubyworks/shelob","last_synced_at":"2025-10-04T09:58:49.296Z","repository":{"id":66244234,"uuid":"4996440","full_name":"rubyworks/shelob","owner":"rubyworks","description":"Static site generator extension for Smeagol","archived":false,"fork":false,"pushed_at":"2013-11-26T01:47:40.000Z","size":132,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-02T09:45:12.395Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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":"2012-07-11T23:07:08.000Z","updated_at":"2018-06-19T11:13:40.000Z","dependencies_parsed_at":"2023-02-20T01:00:43.497Z","dependency_job_id":null,"html_url":"https://github.com/rubyworks/shelob","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rubyworks/shelob","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fshelob","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fshelob/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fshelob/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fshelob/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rubyworks","download_url":"https://codeload.github.com/rubyworks/shelob/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fshelob/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278296082,"owners_count":25963432,"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","status":"online","status_checked_at":"2025-10-04T02:00:05.491Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-08-01T12:04:52.192Z","updated_at":"2025-10-04T09:58:49.249Z","avatar_url":"https://github.com/rubyworks.png","language":"Ruby","funding_links":[],"categories":["Ruby","others"],"sub_categories":[],"readme":"Shelob - Static Web Spinner for Gollum Wiki\n===========================================\n\n[Website](http://rubyworks.github.com/shelob) /\n[Documentation](http://rubydoc.info/rubyworks/shelob) /\n[Source Code](http://github.com/rubyworks/shelob) /\n[Report Issue](http://github.com/rubyworks/shelob/issues)\n\n\n## DESCRIPTION\n\nShelob is a static website generator for creating customizable renditions\nof [Gollum](http://github.com/github/gollum) wiki. This can be useful when\nyou want to maintain a standalone website, but you want to update it through\nthe Gollum wiki interface, e.g. via GitHub.\n\nShelob depends on Smeagol, a read-only web server for Gollum.\n\n\n## INSTALLATION\n\nYou can install Shelob with RubyGems:\n\n    $ [sudo] gem install shelob\n\nAnd then, if you want code highlighting, follow the\n[Installation Guide](http://pygments.org/docs/installation) for Pygments.\n\nTa da! You're ready to go.\n\n\n## CUSTOMIZING\n\nThe first thing you need to do is clone your Gollum wiki repo.\n\n    $ git clone git@github.com:user/user.github.com.git\n\nOf course, you want to customize your site to suit your style. To do this you\nneed to add some some support files. Use the `init` command to have Shelob\nput the default files in place.\n\n    $ cd path/to/wiki\n    $ shelob-init\n\nNote, this is practically identical to using `smeagol-init`, so if had already \ndone that there is no need to do this.\n\nIn your wiki this will add a few files. One of these is `_settings.yml` which you\nuse to configure Shelob for your site. See SETTINGS below.\n\nThere will also be a file called `_layouts/default.html`. Using Mustache\ntemplating use this file to create a custom page layout for your site.\nTo learn more about the variables available for use in this template see\nthe [Shelob Wiki](http://github.com/rubyworks/shelob/wiki).\n\nBe sure to add these files to commit these files to your repo. You can just\ncheck these files in and push to the server. It will not effect you Gollum\nwiki in any way.\n\n\n## SETTINGS\n\nThe `_settings.yml` file allows you to configure certain behaviors of Shelob.\nAn example `_settings.yml` file:\n\n    ---\n    title: 7R4N5.C0D3\n    url: http://trans.github.com\n    author: trans\n    description:\n      Trans Programming Blog\n\n    source_url: http://github.com/trans\n\n    menu:\n    - title: Homepage\n      href: \"/\"\n    - title: RSS Feed\n      href: \"/rss.xml\"\n    - title: Projects\n      href: \"http://github.com/trans\"\n\nSee the documentation for more details about each field and others that\nare available.\n\n\n## PREVIEWING\n\nTo preview your site via shelob, simply change directories to your Gollum repository\nand run `shelob-preview` from the command line:\n\n    $ cd /path/to/repo\n    $ shelob-preview\n\nThis will run a web server at `http://localhost:4567`. You can change the port\nby setting the `--port` or `-p` option on the command line.\n\n\n## DEPLOYING\n\nIf your site can be deployed by pushing to a git repository, Shelob can be \nused to do so.\n\n    $ shelob-deploy\n\n\n## CONTRIBUTE\n\nHave a great idea for Shelob? Awesome. Fork the repository and add a feature\nor fix a bug. There are a couple things I ask:\n\n* Create an appropriately named topic branch that contains your change.\n* Please try to provide tests for all code you check in.\n\nNote that Shelob uses QED, Citron and AE for testing. And admittedly the project\nis water-falling too much at present. So if you would like to contribute, but\ndon't have any specific request, writing a few tests would be a great help.\n\n\n## COPYRIGHTS\n\nShelob is distributed under the terms of the **BSD-2-Clause** license.\n\n* Copyright 2012 Trans, Rubyworks\n* Copyright 2009 Ben Johnson\n\nPlease see LICENSE.txt file for details.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubyworks%2Fshelob","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frubyworks%2Fshelob","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubyworks%2Fshelob/lists"}