[PR #8876] [MERGED] chore(docs): scope remark linting to docs with standard presets #16517

Closed
opened 2026-04-13 10:33:15 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/better-auth/better-auth/pull/8876
Author: @bytaesu
Created: 4/1/2026
Status: Merged
Merged: 4/1/2026
Merged by: @bytaesu

Base: mainHead: chore/switch-remark-preset


📝 Commits (2)

  • 9352f02 chore: switch remark preset to lint-consistent and lint-recommended
  • edcfeac chore(docs): scope remark linting to docs and replace preset

📊 Changes

6 files changed (+113 additions, -1015 deletions)

View changed files

.remarkignore (+0 -10)
.remarkrc.mjs (+0 -6)
docs/.remarkrc.mjs (+13 -0)
📝 docs/package.json (+7 -0)
📝 package.json (+2 -5)
📝 pnpm-lock.yaml (+91 -994)

📄 Description

When should I use this?

This project is useful when developers or technical writers are authoring documentation in markdown and you want to ensure that the markdown is consistent, free of bugs, and works well across different markdown parsers.

These packages are quite good at checking markdown. They especially shine when combined with other remark plugins and at letting you make your own rules.

See: https://github.com/remarkjs/remark-lint?tab=readme-ov-file#when-should-i-use-this

First, this plugin is basically intended for documentation management. So if we use it, we should target docs rather than adding ignores one by one. Also, I'm not sure why we're using that plugin. If we're going to use remark, it'd be better to go with a more widely used option.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/better-auth/better-auth/pull/8876 **Author:** [@bytaesu](https://github.com/bytaesu) **Created:** 4/1/2026 **Status:** ✅ Merged **Merged:** 4/1/2026 **Merged by:** [@bytaesu](https://github.com/bytaesu) **Base:** `main` ← **Head:** `chore/switch-remark-preset` --- ### 📝 Commits (2) - [`9352f02`](https://github.com/better-auth/better-auth/commit/9352f02881ccb651138c39a39f5c18fc7ffc3f38) chore: switch remark preset to lint-consistent and lint-recommended - [`edcfeac`](https://github.com/better-auth/better-auth/commit/edcfeac0985c7d2f5b7243beb16515c885a6167d) chore(docs): scope remark linting to docs and replace preset ### 📊 Changes **6 files changed** (+113 additions, -1015 deletions) <details> <summary>View changed files</summary> ➖ `.remarkignore` (+0 -10) ➖ `.remarkrc.mjs` (+0 -6) ➕ `docs/.remarkrc.mjs` (+13 -0) 📝 `docs/package.json` (+7 -0) 📝 `package.json` (+2 -5) 📝 `pnpm-lock.yaml` (+91 -994) </details> ### 📄 Description > ## When should I use this? > > This project is useful when developers or technical writers are authoring documentation in markdown and you want to ensure that the markdown is consistent, free of bugs, and works well across different markdown parsers. > > These packages are quite good at checking markdown. They especially shine when combined with other [remark plugins](https://github.com/remarkjs/remark#plugins) and at letting you make your own rules. > > See: https://github.com/remarkjs/remark-lint?tab=readme-ov-file#when-should-i-use-this First, this plugin is basically intended for documentation management. So if we use it, we should target docs rather than adding ignores one by one. Also, I'm not sure why we're using that plugin. If we're going to use remark, it'd be better to go with a more widely used option. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-13 10:33:15 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/better-auth#16517