oasisprotocol / oasisprotocol/docs
Github markdown (not docusaurus) display is broken if ``` isn't preceded by a blank line
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 15
- Forks
- 46
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 1
Description
If someone is browsing docs on github instead of docusaurus
https://github.com/oasisprotocol/docs/blob/b80c7dadd51f6330ed70fb13d7f4a0c796b7f44d/docs/build/use-cases/price-oracle.mdx
Ideally this could be detected by changing https://github.com/oasisprotocol/docs/blob/b80c7dadd51f6330ed70fb13d7f4a0c796b7f44d/.markdownlint-cli2.cjs#L12 and auto-fixed with fmt-markdown. But in the following case it thinks opening fence is invalid and closing fence is opening :/
<details>
<summary>Dockerfile</summary>
```dockerfile
FROM python:alpine3.17
WORKDIR /bot
COPY ./bot.py ./requirements.txt /bot
RUN pip install -r requirements.txt
CMD ["python", "bot.py"]
+
```
</details>
Contributor guide
No contributing guide indexed for this repository
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 .markdownlint-cli2.cjs and the linked docs/build/use-cases/price-oracle.mdx example, then reproduce how GitHub renders a fenced block without a preceding blank line. Done means the problematic fence pattern is detected or auto-fixed without misclassifying the nested diff example; verify both linting and the resulting GitHub Markdown.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, markdown
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100