Standardize whitespace and tabs in source for indentation-sensitive markup features #755
Labels
maintenance
Preserving quality source code and tools for docs authors (via GitHub Actions, CLI utilities, etc.)
mkdocs enhancement
Changes to mkdocs features, mkdocs-material theme, custom theme overrides, etc.
style
subjective design choices, language conventions, how and when to use mkdocs & theme features
A note from #640, specifically https://github.com/argonne-lcf/user-guides/pull/640/files#r1919104321
Admonitions can be very picky about indentation in order to render correctly:
E.g. when using
!!! note
the block should begin on the next line with content with the first letter under then
(or later?)A single tab character seems to still work, e.g. in:
user-guides/docs/aurora/running-jobs-aurora.md
Lines 408 to 410 in 695a3d0
(and throughout that
.md
, it seems like a mix of whitespace+tabs, 6 whitespaces, etc. indentation for Admonitions all seem to render correctly inmkdocs-material
...)By default, GitHub renders tabs in Markdown rich previews as 8 spaces, so it can be hard to spot errors. And changing a GitHub user's default "number of spaces a tab is equal to when rendering code" from 8 to 4 via https://github.com/settings/appearance is not reflected everywhere, e.g. the above permalink snippet in this comment.

Tab characters would be better replaced by 4 whitespaces. Our AI proofreader seems to agree; it replaced the tab character below with 4 spaces in 8a62194

Related to #330 and the potential benefit from having automatically-enforced style rules.
The text was updated successfully, but these errors were encountered: