Skip to content

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

Merged
danielroe merged 3 commits intonpmx-dev:mainfrom
idleberg:feature/markdown-extension
Jan 26, 2026
Merged

feat: add support for markdown extension in readme files#123
danielroe merged 3 commits intonpmx-dev:mainfrom
idleberg:feature/markdown-extension

Conversation

@idleberg
Copy link
Contributor

Both GitHub and npm CLI support the .markdown extension for README files. It's the file-extension endorsed by John Gruber, the inventor of Markdown, but we all know that almost no one uses it. However, since it's a simple change, I thought I'd open a PR. I was unsure regarding the casing; not all file names support all variants. JSDelivr allows them as well, see https://www.jsdelivr.com/package/npm/json-stable-stringify?tab=files&version=1.0.1

@vercel
Copy link

vercel bot commented Jan 26, 2026

@idleberg is attempting to deploy a commit to the danielroe Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

@43081j 43081j left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

makes sense 👍

@autofix-troubleshooter
Copy link

Hi! I'm the autofix logoautofix.ci troubleshooter bot.

It looks like you correctly set up a CI job that uses the autofix.ci GitHub Action, but the autofix.ci GitHub App has not been installed for this repository. This means that autofix.ci unfortunately does not have the permissions to fix this pull request. If you are the repository owner, please install the app and then restart the CI workflow! 😃

@vercel
Copy link

vercel bot commented Jan 26, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
npmx.dev Ready Ready Preview, Comment Jan 26, 2026 2:16pm

Request Review

@danielroe danielroe merged commit d99b590 into npmx-dev:main Jan 26, 2026
8 checks passed
vinnymac pushed a commit to vinnymac/npmx.dev that referenced this pull request Jan 28, 2026
sacrosanctic added a commit to sacrosanctic/npmx.dev that referenced this pull request Mar 10, 2026
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

### My notes
- enable autodics
  - need support for dark mode
  - i18n is causing errors
- remove snapshot story (replaced by autodocs)
- add a playground story
  - autodocs has this but requires scrolling

#### types of stories
- visual stories - only show in autodocs
- interactive stories only show in sidebar
- test focused stories - only show in sidebar (or not at all? if it isnt visually apparent)

### 🔗 Linked issue

<!-- Please ensure there is an open issue and mention its number. For example, "resolves npmx-dev#123" -->

### 🧭 Context

<!-- Brief background and why this change is needed -->

<!-- High-level summary of what changed -->

### 📚 Description

<!-- Describe your changes in detail. Why is this change required? What problem does it solve? -->

<!-- If you used AI tools to help with this contribution, please ensure the PR description and code reflect your own understanding.
     Write in your own voice rather than copying AI-generated text. -->

<!----------------------------------------------------------------------
Before creating the pull request, please make sure you do the following:

- Check that there isn't already a PR that solves the problem the same way. If you find a duplicate, please help us reviewing it.
- Ensure that PR title follows conventional commits (https://www.conventionalcommits.org)
- Update the corresponding documentation if needed.
- Include relevant tests that fail without this PR but pass with it.
- Add any additional context, tradeoffs, follow-ups, or things reviewers should be aware of.

Thank you for contributing to npmx!
----------------------------------------------------------------------->
sacrosanctic added a commit to sacrosanctic/npmx.dev that referenced this pull request Mar 10, 2026
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

### My notes
- enable autodics
  - need support for dark mode
  - i18n is causing errors
- remove snapshot story (replaced by autodocs)
- add a playground story
  - autodocs has this but requires scrolling

#### types of stories
- visual stories - only show in autodocs
- interactive stories only show in sidebar
- test focused stories - only show in sidebar (or not at all? if it isnt visually apparent)

### 🔗 Linked issue

<!-- Please ensure there is an open issue and mention its number. For example, "resolves npmx-dev#123" -->

### 🧭 Context

<!-- Brief background and why this change is needed -->

<!-- High-level summary of what changed -->

### 📚 Description

<!-- Describe your changes in detail. Why is this change required? What problem does it solve? -->

<!-- If you used AI tools to help with this contribution, please ensure the PR description and code reflect your own understanding.
     Write in your own voice rather than copying AI-generated text. -->

<!----------------------------------------------------------------------
Before creating the pull request, please make sure you do the following:

- Check that there isn't already a PR that solves the problem the same way. If you find a duplicate, please help us reviewing it.
- Ensure that PR title follows conventional commits (https://www.conventionalcommits.org)
- Update the corresponding documentation if needed.
- Include relevant tests that fail without this PR but pass with it.
- Add any additional context, tradeoffs, follow-ups, or things reviewers should be aware of.

Thank you for contributing to npmx!
----------------------------------------------------------------------->
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.

5 participants