https://github.com/zzak/sdoc

Standalone sdoc generator
https://github.com/zzak/sdoc

Keywords from Contributors

activerecord mvc activejob rubygems rack documentation-tool sinatra rake rubocop rakefile

Last synced: about 22 hours ago
JSON representation

Repository metadata

Standalone sdoc generator

Host: GitHub
URL: https://github.com/zzak/sdoc
Owner: zzak
License: other
Fork: true (rails/sdoc)
Created: 2023-04-12T05:45:31.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2025-11-16T14:30:32.000Z (4 months ago)
Last Synced: 2026-02-27T04:34:40.452Z (5 days ago)
Language: JavaScript
Homepage: http://api.rubyonrails.org/
Size: 1.39 MB
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
Releases: 0

https://github.com/zzak/sdoc/blob/main/

          # SDoc

[![Tests](https://github.com/rails/sdoc/actions/workflows/test.yml/badge.svg)](https://github.com/rails/sdoc/actions/workflows/test.yml)

**Powering http://api.rubyonrails.org/**

### What is sdoc?

SDoc is an HTML template built on top of the RDoc documentation generator for Ruby code.

### Getting Started

```bash
# Install the gem
gem install sdoc

# Generate documentation for 'projectdir'
sdoc projectdir
```

### sdoc

`sdoc` is simply a wrapper for the `rdoc` command line tool. See `sdoc --help` for more details.

When 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.

Example:

```bash
sdoc -o doc/rails -T direct rails
```

### Rake Task

If you want, you can setup a task in your `Rakefile` for generating your project's documentation via the `rake rdoc` command.

```ruby
# Rakefile
require 'sdoc' # and use your RDoc task the same way you used it before
require 'rdoc/task' # ensure this file is also required in order to use `RDoc::Task`

RDoc::Task.new do |rdoc|
  rdoc.rdoc_dir = 'doc/rdoc'      # name of output directory
  rdoc.options << '--format=sdoc' # explicitly set the sdoc generator
  rdoc.template = 'rails'         # template used on api.rubyonrails.org
end
```

NOTE: If you don't set `template` the default "sdoc" template is chosen, with a lighter color scheme.

Now you can execute this command with `rake rdoc`, to compile the documentation for the current project directory.

Alternatively you can pass this command a path to the project you wish to compile: `rake rdoc path/to/project`.

### RDoc

As mentioned before, SDoc is built on top of the RDoc project.

If 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).

An example of an SDoc bug would be:

* Error or warning in JavaScript or HTML found in your browser
* Generation fails with some exception (likely due to incompatibility with RDoc)

Please 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.

## Contributing

If you'd like to contribute you can generate the Rails main branch documentation by running:

```bash
bundle exec rake test:rails
```

You can generate the Ruby default branch documentation by running:

```bash
bundle exec rake test:ruby
```

The generated documentation will be put into `doc/public` directory.
To view the just generated documentation start up a rack application by running:

```bash
bundle exec rackup config.ru
```

Then open http://localhost:9292 in the browser to view the documentation.

### Who?

* Vladimir Kolesnikov ([voloko](https://github.com/voloko))
* Nathan Broadbent ([ndbroadbent](https://github.com/ndbroadbent))
* Petrik de Heus ([p8](https://github.com/p8))
* ([zzak](https://github.com/zzak))

Owner metadata

Name:
Login: zzak
Email:
Kind: user
Description:
Website:
Location:
Twitter:
Company:
Icon url: https://avatars.githubusercontent.com/u/277819?u=f88292414deeecfd67fee18ae9d7297bcc001138&v=4
Repositories: 223
Last ynced at: 2024-05-01T10:38:08.127Z
Profile URL: https://github.com/zzak

GitHub Events

Total

Push event: 1
Create event: 1

Last Year

Push event: 1
Create event: 1

Committers metadata

Last synced: about 22 hours ago

Total Commits: 630
Total Committers: 73
Avg Commits per committer: 8.63
Development Distribution Score (DDS): 0.768

Commits in past year: 7
Committers in past year: 2
Avg Commits per committer in past year: 3.5
Development Distribution Score (DDS) in past year: 0.143

Name	Email	Commits
Jonathan Hefner	j**n@h**o	146
Volodya Kolesnikov	v**o@g**m	140
Petrik	p**k@d**t	56
Zachary Scott	e@z****o	30
Robin Dupret	r**t@g**m	30
Zachary Scott	z**y@z**t	27
zzak	z**t@g**m	25
Zachary Scott	m**l@z**o	19
Mike Rogers	me@m****o	18
Nathan Broadbent	n**7@g**m	15
Boba Fat	i**n@w**u	13
Aleksey Palazhchenko	a**e@g**m	9
Mikhail	m**t@g**m	8
toshimaru	me@t****t	6
Code Ass	a**a@g**m	6
Jack Chen	c**o@c**t	5
Manuel Meurer	m**l@k**m	5
Yoshiyuki Hirano	y**o@m**m	4
Xuhao	x**o@e**m	3
Ben Fyvie	g**n@h**m	3
Earlopain	1****n	3
Xuhao	x**o@r**m	2
Travis Tilley	t**y@g**m	2
Paul Annesley	p**l@a**c	2
Jean Mertz	j**n@m**m	2
Frédéric Mascaro	f**o@w**m	2
chendo	c****t	2
m-nakamura145	m**5@g**m	2
Adam McCrea	a**m@a**m	1
Akira Matsuda	r**e@d**p	1
and 43 more...

Committer domains:

Issue and Pull Request metadata

Last synced: 9 days ago

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull request: 0
Bot issues: 0
Bot pull requests: 0

Past year issues: 0
Past year pull requests: 0
Past year average time to close issues: N/A
Past year average time to close pull requests: N/A
Past year issue authors: 0
Past year pull request authors: 0
Past year average comments per issue: 0
Past year average comments per pull request: 0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/zzak/sdoc

Top Issue Authors

Top Pull Request Authors

Top Issue Labels

Top Pull Request Labels

Package metadata

Total packages: 2
Total downloads:
- rubygems: 157,801,157 total
Total docker downloads: 83,544,388
Total dependent packages: 125 (may contain duplicates)
Total dependent repositories: 293,921 (may contain duplicates)
Total versions: 114
Total maintainers: 3

gem.coop: sdoc

rdoc generator html with javascript search index.

Homepage: https://github.com/zzak/sdoc
Documentation: http://www.rubydoc.info/gems/sdoc/
Licenses: MIT
Latest release: 2.6.5 (published 5 months ago)
Last Synced: 2026-03-02T11:32:31.694Z (1 day ago)
Versions: 57
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 78,907,716 Total
Docker Downloads: 41,772,194
Rankings:
- Dependent repos count: 0.0%
- Dependent packages count: 0.0%
- Average: 0.25%
- Downloads: 0.362%
- Docker downloads count: 0.636%
Maintainers (3)

rubygems.org: sdoc