Skip to content

Conversation

@gouttegd
Copy link
Contributor

This PR fixes a small formatting issue in the recently merged RDF specification.

The Markdown implementation used by Mkdocs only recognizes nested lists if the nested list items are indented by precisely 4 spaces (or a tab character) compared to the parent list item.

This was not caught prior to merging because I (and likely anyone who reviewed the PR) relied on GitHub’s Markdown preview, but the Github-flavoured Markdown is slightly different from the Mkdocs Markdown. Therefore the PR also amends the contributing documentation to recommend that documentation editors run make serve locally.

The Markdown implementation used by Mkdocs only recognizes nested lists
if the nested list items are indented by precisely *4 spaces* (or a tab
character) compared to the parent list item.
Markdown files are interpreted slightly differently between GitHub and
Mkdocs, so we cannot rely solely on GitHub's preview feature to ensure
that a Markdown file is rendered as we expect.

People who edit the documentation should run `make serve` locally
instead.
@gouttegd gouttegd self-assigned this Oct 20, 2025
@gouttegd gouttegd requested a review from matentzn October 20, 2025 13:50
@matentzn matentzn merged commit b603c25 into master Oct 20, 2025
3 checks passed
@matentzn matentzn deleted the fix-indenting branch October 20, 2025 13:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants