typelevel / typelevel/cats-mtl
Logo image is rendered incorrectly by Laika
Open
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 307
- Forks
- 66
- Avg merge
- 6h 23m
- Merged PRs (30d)
- 2
Description
...although it looks alright in GitHub.
For now the microsite index page looks like this:
The reason is that README.md is re-used for docs/index.md (via symlinking) and contains this line:
<img src="https://typelevel.org/cats-mtl/img/cats-mtl-logo.png" width="200px" height="231px" align="right">
Apparently it is rendered differently by GitHub and Laika: GitHub understands it as a correct HTML tag, whereas Laika renders it as a literal string.
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
Inspect README.md and the symlinked docs/index.md to confirm the image markup used by the microsite. Check how Laika renders that img tag versus GitHub, then preview the microsite and verify the cats-mtl logo is rendered as an image rather than literal text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html, markdown
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100