chore: fix npm lost readme #237
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
现状
现有根目录 README.md 是从 docs/index.md 软链接过来,为了同时在 websilte 显示和 github 中显示,又不维护多处。
但因为根目录下没有实际的 README.md,导致 https://www.npmjs.com/package/rc-field-form 没有显示介绍。
解决方案
为了不使得 README 维护两处,现移除 docs/index,根目录 README 使用实际内容。这样在 website 构建时目录为:
这个标题的显示 README 的问题看这里:umijs/dumi#408
为了暂时规避掉这个标题的问题,又在 umi 的 config 里强行用 js 改了
等 umijs/dumi#408 解决后,可移除这段 script