Documentation point to wrong `npm` package

Đang mở

#46 mở ngày 8/6/2023 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó: 2/5
Thời gian dự kiến: 1-3 giờ
Mức phù hợp với người mới: 48/100

Loại issue: Tài liệu
Độ rõ ràng: Đặc tả rõ ràng
Mức độ hoạt động: Đình trệ
Lĩnh vực: documentation

Hướng nghiên cứu

So sánh README.md và website/docs/plugins/docusaurus-remark-plugin-import-file.mdx với packages/docusaurus-remark-plugin-import-file/package.json. Cập nhật tiêu đề gói và lệnh cài đặt được ghi trong tài liệu để khớp với tên gói hiển thị trong package.json và trên trang npm. Hoàn thành khi README và tài liệu plugin nhất quán xác định cùng một gói.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Hello, I wanted to try the plugin remark-plugin-import-file if it fit my use case. However, there seems to have a lot of discrepancies in this repository regarding this package. Probably due to the recent changes in namespace?

What is working

NPM package page: https://www.npmjs.com/package/@rise4fun/docusaurus-remark-plugin-import-file
pnpm add command: pnpm add @rise4fun/docusaurus-remark-plugin-import-file
- I would assume it's the same for npm install and yarn add.

What is not aligned what is working

README.md
- Source
  https://github.com/microsoft/docusaurus-plugins/blob/328986884c0f4a61295897bd8e4a588696c7219f/packages/docusaurus-remark-plugin-import-file/README.md?plain=1#L3
- Issue
  Looks like a typo in the package name? Word file is ending with a s, but the package isn't.
  https://github.com/microsoft/docusaurus-plugins/blob/328986884c0f4a61295897bd8e4a588696c7219f/packages/docusaurus-remark-plugin-import-file/package.json#L2
Documentation
- Source
  https://github.com/microsoft/docusaurus-plugins/blob/328986884c0f4a61295897bd8e4a588696c7219f/website/docs/plugins/docusaurus-remark-plugin-import-file.mdx?plain=1#L5
- Issue
  The title of the package in the docs (including elsewhere this title is reused by Docusaurus) does not match the package name. Looking at Docusaurus itself for their plugins, they just leave the scope (plugin-content-docs = @docusaurus/plugin-content-docs). Meaning, when reading the docs I assumed the package name was remark-plugin-import-file, plus whatever scope. But it is not!
Documentation
- Source
  https://github.com/microsoft/docusaurus-plugins/blob/328986884c0f4a61295897bd8e4a588696c7219f/website/docs/plugins/docusaurus-remark-plugin-import-file.mdx?plain=1#L18
- Issue
  The npm package name shown in the command does not match either doc title or package itself.

Regards!

Ngôn ngữ chính: TypeScript
Star: 17
Fork: 6
Merge trung bình: 1 ngày 12 giờ
Pull request đã merge (30 ngày): 1

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
Fork repository và làm thay đổi trên một nhánh.
Mở pull request có tham chiếu số hiệu của issue.

Issue khác của microsoft/docusaurus-plugins

support docusaurus v3 Đang mở

Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 25/100

microsoft/docusaurus-plugins#51 · 1 bình luận · 2 reaction · Mở ngày 12/2/2024
Plugin for Azure Search Đang mở

Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 25/100

microsoft/docusaurus-plugins#48 · Mở ngày 5/9/2023
[feat][@rise4fun/docusaurus-remark-plugin-import-file]: Add an option to always import a given file Đang mở

Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 45/100

microsoft/docusaurus-plugins#47 · Mở ngày 8/6/2023
Publish under @microsoft scope Đang mở

Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 25/100

microsoft/docusaurus-plugins#18 · Mở ngày 17/3/2023
support vfile-location to create better error message Đang mở

Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 30/100

microsoft/docusaurus-plugins#3 · Mở ngày 17/1/2023

Tất cả issue của microsoft/docusaurus-plugins

Issue tương tự

web: `npm run build -w web` always fails — `vite.config.ts` does not typecheck (TS18048) Đang mở

comp/dashboard P3 type/bug

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 86/100

NousResearch/hermes-agent#117722 · Mở ngày 21/9/2026
[Bug]: Session row status indicator sits flush against the selection pill's rounded corner Đang mở

clawsweeper:fix-shape-clear clawsweeper:queueable-fix clawsweeper:source-repro impact:ux-friction issue-rating: 🦞 diamond lobster no-stale P3

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100

openclaw/openclaw#154145 · 2 bình luận · 1 reaction · Mở ngày 20/9/2026
[good first issue] 🀄 Add new Grammar Point 265 (good-first-issue) Đang mở

community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs

Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 76/100

lingdojo/kana-dojo#30632 · 1 bình luận · 5 reaction · Mở ngày 20/9/2026
[Duplicate Code] Repeated filtered model-alias assembly in proxy server Đang mở

code-quality refactoring

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100

github/gh-aw-firewall#8816 · Mở ngày 20/9/2026
quickjs: support `timeout=None` (no per-call deadline) in `CodeInterpreterMiddleware` Đang mở

integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature

Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 74/100

langchain-ai/deepagents#6450 · Mở ngày 20/9/2026

Thêm issue về TypeScript