Allow sites to specify favicon
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
Description
- There needs to be an option (
favicon_path?) to copy favicon to the output directory.static_pathonly copies files under the generator's folder. - The option should be available in at least Rake task AND
.rdoc_options. Not sure if practical to be a command line option, but I'm not against it. - Templates should take this option into account and add a
<link rel="icon" type="image/x-icon" href="/images/favicon.ico">to the header when it's set. - (Maybe) RDoc can provide a default favicon too?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing how the Rake task, .rdoc_options, static_path, and HTML templates handle configuration and generated output. Define how favicon_path is accepted and copied, then verify that templates emit the requested icon link when it is set and that existing generation remains unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100