axodotdev / axodotdev/oranda

README.md generated HTML is being rendered in quoted string on homepage for some reason

Open
#714 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
543
Forks
34
PR merge metrics
No merged PRs in 30d

Description

I updated to oranda 0.6.5 to add to an existing Oranda site: https://hickory-dns.org. The README.md is part of a git submodule. The site config is pretty basic:

```
{
"styles": {
"theme": "hacker",
"favicon": "static/favicon.ico",
"logo": "static/logo.png"
},
"project": {
"name": "Hickory DNS",
"readme_path": "hickory-dns/README.md",
"repository": "https://github.com/hickory-dns/hickory-dns",
"license": "MIT OR Apache-2.0"
}
}
```

https://github.com/hickory-dns/hickory-dns.github.io/blob/main/oranda.json

After the update, this got produced in the body, when served locally, you can that the body of the README.md is escaped on inclusion in the primary home page document:

```
...

<p><a href="https://www.whatrustisit.com" rel="noopener noreferrer"><img src="https://img.shields.io/badge/minimum%20rustc-1.70-green?logo=rust" alt="minimum rustc: 1.70"></a>
...
```

Is there something that I need to change?

Contributor guide

No contributing guide indexed for this repository

Research direction

Reproduce the issue with the linked oranda.json configuration and the README.md supplied through the git submodule. Inspect the generated homepage HTML and compare the README content before and after generation. Done means the README renders as HTML on the homepage rather than as escaped text.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
web-dev
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.