Skip to content

docs: fix man page cross-references to use proper man page notation#1751

Open
claw-explorer wants to merge 1 commit intoeza-community:mainfrom
claw-explorer:fix/man-page-docs
Open

docs: fix man page cross-references to use proper man page notation#1751
claw-explorer wants to merge 1 commit intoeza-community:mainfrom
claw-explorer:fix/man-page-docs

Conversation

@claw-explorer
Copy link
Copy Markdown

Summary

Fix man page cross-references in all three man pages to use standard man page notation instead of markdown-style links with .md suffixes.

Changes

  • eza.1.md: Fix SEE ALSO section and inline eza_colors.5.md reference in EZA_COLORS docs
  • eza_colors.5.md: Fix SEE ALSO section
  • eza_colors-explanation.5.md: Fix See also section

Before (rendered in man page)

SEE ALSO
  • eza_colors(5) (eza_colors.5.md)
  • eza_colors-explanation(5) (eza_colors-explanation.5.md)

After (rendered in man page)

SEE ALSO
  eza_colors(5), eza_colors-explanation(5)

The markdown-style [text](file.md) links were appearing literally in rendered man pages (via pandoc), making the references look broken and non-functional. Standard man page notation (**name**(section)) renders correctly as bold text with the section number.

Partially fixes #981 (item 3: SEE ALSO section pointing to .md files).

Replace markdown-style links with .md suffixes in SEE ALSO sections
with standard man page notation (e.g., **eza_colors**(5)).

The .md extensions were appearing literally in rendered man pages,
making the references non-functional. This also fixes the inline
reference to eza_colors.5.md in the EZA_COLORS environment variable
documentation.

Fixes part of eza-community#981
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.

bug: Problems with man pages

1 participant