Skip to content

feat: add support for markdown extension in readme files #123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
danielroe merged 3 commits into from
Jan 26, 2026
Merged

feat: add support for markdown extension in readme files #123

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
769dead
feat: add support for markdown extension in readme files
idleberg Jan 26, 2026
30c764b
Merge branch 'main' into feature/markdown-extension
serhalp Jan 26, 2026
e2e9396
[autofix.ci] apply automated fixes
autofix-ci[bot] Jan 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion app/utils/file-icons.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,8 @@ const FILENAME_ICONS: Record<string, string> = {
'README': 'i-vscode-icons-file-type-markdown',
'README.md': 'i-vscode-icons-file-type-markdown',
'readme.md': 'i-vscode-icons-file-type-markdown',
'Readme.md': 'i-vscode-icons-file-type-markdown',
'README.markdown': 'i-vscode-icons-file-type-markdown',
'readme.markdown': 'i-vscode-icons-file-type-markdown',
'CHANGELOG': 'i-vscode-icons-file-type-markdown',
'CHANGELOG.md': 'i-vscode-icons-file-type-markdown',
'changelog.md': 'i-vscode-icons-file-type-markdown',
Expand Down
2 changes: 1 addition & 1 deletion server/api/registry/readme/[...pkg].get.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ async function fetchReadmeFromJsdelivr(
packageName: string,
version?: string,
): Promise<string | null> {
const filenames = ['README.md', 'readme.md', 'Readme.md', 'README', 'readme']
const filenames = ['README.md', 'readme.md', 'Readme.md', 'README', 'readme', 'README.markdown', 'readme.markdown']
const versionSuffix = version ? `@${version}` : ''

for (const filename of filenames) {
Expand Down
1 change: 1 addition & 0 deletions server/utils/code-highlight.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ const FILENAME_MAP: Record<string, string> = {
'CHANGELOG.md': 'markdown',
'README': 'markdown',
'README.md': 'markdown',
'README.markdown': 'markdown',
}

/**
Expand Down
Loading