{"id":13463171,"url":"https://github.com/rails/sdoc","last_synced_at":"2025-04-13T20:20:25.614Z","repository":{"id":526915,"uuid":"155632","full_name":"rails/sdoc","owner":"rails","description":"Standalone sdoc generator","archived":false,"fork":false,"pushed_at":"2025-03-30T18:04:29.000Z","size":1544,"stargazers_count":820,"open_issues_count":6,"forks_count":133,"subscribers_count":18,"default_branch":"main","last_synced_at":"2025-04-05T02:35:19.637Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://api.rubyonrails.org/","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/rails.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2009-03-21T08:57:10.000Z","updated_at":"2025-04-04T02:18:35.000Z","dependencies_parsed_at":"2024-01-18T01:10:57.626Z","dependency_job_id":"ae1e5a26-31aa-4c52-b4fb-979c66c95cb1","html_url":"https://github.com/rails/sdoc","commit_stats":{"total_commits":622,"total_committers":75,"mean_commits":8.293333333333333,"dds":0.77491961414791,"last_synced_commit":"cd75e36ce2d1acb66734c1390ffe33aa05479380"},"previous_names":["voloko/sdoc"],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rails%2Fsdoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rails%2Fsdoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rails%2Fsdoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rails%2Fsdoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rails","download_url":"https://codeload.github.com/rails/sdoc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248775789,"owners_count":21159664,"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-07-31T13:00:47.305Z","updated_at":"2025-04-13T20:20:25.581Z","avatar_url":"https://github.com/rails.png","language":"JavaScript","readme":"# SDoc\n\n[![Tests](https://github.com/rails/sdoc/actions/workflows/test.yml/badge.svg)](https://github.com/rails/sdoc/actions/workflows/test.yml)\n\n**Powering http://api.rubyonrails.org/**\n\n### What is sdoc?\n\nSDoc is an HTML template built on top of the RDoc documentation generator for Ruby code.\n\n### Getting Started\n\n```bash\n# Install the gem\ngem install sdoc\n\n# Generate documentation for 'projectdir'\nsdoc projectdir\n```\n\n### sdoc\n\n`sdoc` is simply a wrapper for the `rdoc` command line tool. See `sdoc --help` for more details.\n\nWhen using the `sdoc` command, `--fmt` is set to `shtml` by default. The default template (or `-T` option) is set to `shtml`, but you can also use the `direct` template when generating documentation.\n\nExample:\n\n```bash\nsdoc -o doc/rails -T direct rails\n```\n\n### Rake Task\n\nIf you want, you can setup a task in your `Rakefile` for generating your project's documentation via the `rake rdoc` command.\n\n```ruby\n# Rakefile\nrequire 'sdoc' # and use your RDoc task the same way you used it before\nrequire 'rdoc/task' # ensure this file is also required in order to use `RDoc::Task`\n\nRDoc::Task.new do |rdoc|\n  rdoc.rdoc_dir = 'doc/rdoc'      # name of output directory\n  rdoc.options \u003c\u003c '--format=sdoc' # explicitly set the sdoc generator\n  rdoc.template = 'rails'         # template used on api.rubyonrails.org\nend\n```\n\nNOTE: If you don't set `template` the default \"sdoc\" template is chosen, with a lighter color scheme.\n\nNow you can execute this command with `rake rdoc`, to compile the documentation for the current project directory.\n\nAlternatively you can pass this command a path to the project you wish to compile: `rake rdoc path/to/project`.\n\n### RDoc\n\nAs mentioned before, SDoc is built on top of the RDoc project.\n\nIf you notice any bugs in the output of your documentation, it may be RDoc's fault and should be [reported upstream](https://github.com/ruby/rdoc/issues/new).\n\nAn example of an SDoc bug would be:\n\n* Error or warning in JavaScript or HTML found in your browser\n* Generation fails with some exception (likely due to incompatibility with RDoc)\n\nPlease feel free to still report issues here for both projects, especially if you aren't sure. We will try to redirect to the proper place if necessary.\n\n## Contributing\n\nIf you'd like to contribute you can generate the Rails main branch documentation by running:\n\n```bash\nbundle exec rake test:rails\n```\n\nYou can generate the Ruby default branch documentation by running:\n\n```bash\nbundle exec rake test:ruby\n```\n\nThe generated documentation will be put into `doc/public` directory.\nTo view the just generated documentation start up a rack application by running:\n\n```bash\nbundle exec rackup config.ru\n```\n\nThen open http://localhost:9292 in the browser to view the documentation.\n\n### Who?\n\n* Vladimir Kolesnikov ([voloko](https://github.com/voloko))\n* Nathan Broadbent ([ndbroadbent](https://github.com/ndbroadbent))\n* Petrik de Heus ([p8](https://github.com/p8))\n* ([zzak](https://github.com/zzak))\n","funding_links":[],"categories":["Documentation Tools","JavaScript"],"sub_categories":["Documentation Generators"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frails%2Fsdoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frails%2Fsdoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frails%2Fsdoc/lists"}