@fce/design-md
v0.2.1
Published
Pull DESIGN.md files from awesome-design-md into your project root
Maintainers
Readme
design-md
中文:@fce/design-md 是一个交互式 TUI CLI。运行后,你只需要跟着界面选择语言、选择 design、确认下载,即可把设计资源拉到当前项目里。
English: @fce/design-md is an interactive TUI CLI. Run it, follow the prompts, choose a design, and it will pull design resources into your current project.
中文:当前 npm 包默认从你的仓库 chengzhaobing/awesome-design-md 的 design-md/ 目录动态拉取资源。
English: This npm package now pulls resources dynamically from the design-md/ directory of chengzhaobing/awesome-design-md.
中文:这样即使官方仓库结构调整,只要你的 fork 维持兼容结构,CLI 仍然可以正常工作,并随着你的仓库更新读取新的站点目录。
English: This keeps the CLI working even if the upstream official repository changes structure, as long as your fork keeps a compatible layout. New site folders added to your repository will become selectable automatically.
安装 / Install
中文:临时使用可以直接运行。
English: For one-off usage, run it directly.
npx @fce/design-mdpnpm dlx @fce/design-md中文:如果你想全局安装后长期使用,可以这样安装。
English: If you want to install it globally and use it regularly, install it like this.
npm install -g @fce/design-md
design-md使用方式 / Usage
中文:核心命令只有一个。
English: There is only one main command to remember.
design-md中文:如果你想跳过覆盖确认,可以加 --force。
English: If you want to skip overwrite confirmation, use --force.
design-md --force交互流程 / Interactive Flow
中文:
- 启动
design-md - 选择
Chinese或English - 选择下载方式
- 从你的仓库
design-md/子文件夹中选择需要的 design - 确认下载
- 下载完成后,直接让 AI 使用对应网站的
DESIGN.md
English:
- Start
design-md - Choose
ChineseorEnglish - Choose a download mode
- Select designs from your repository's
design-md/folders - Confirm the download
- After download, let your AI use the corresponding site's
DESIGN.md
交互模式 / Modes
中文:
下载一个 design:下载单个站点全选:下载全部站点自定义:从列表中多选站点
English:
下载一个 design: download a single site全选: download all sites自定义: choose multiple sites from the list
输出规则 / Output Rules
中文:
- 单个站点下载后会生成:
./DESIGN.md./design-md/<site>/DESIGN.md
- 多个站点下载后会统一生成到:
./design-md/<site>/DESIGN.md
English:
- When downloading one site, the CLI creates:
./DESIGN.md./design-md/<site>/DESIGN.md
- When downloading multiple sites, the CLI creates:
./design-md/<site>/DESIGN.md
为什么适合 npm 使用 / Why It Works Well On npm
中文:
- 用户不需要手动去 GitHub 复制文件
- 用户不需要记复杂命令,只要执行
design-md - CLI 会读取你仓库里最新的
design-md/目录 - 你后续新增的资源会自动出现在交互选择中
English:
- Users do not need to manually copy files from GitHub
- Users do not need to remember complex commands, only
design-md - The CLI reads the latest
design-md/folders from your repository - New resources added later will automatically appear in the interactive selector
发布到 npm / Publish To npm
中文:
- 登录 npm:
npm login - 检查打包内容:
npm pack --dry-run - 升级版本:
npm version patch - 正式发布:
npm publish --access public
English:
- Log in to npm:
npm login - Inspect package contents:
npm pack --dry-run - Bump the version:
npm version patch - Publish publicly:
npm publish --access public
中文:发布成功后,其他用户就可以直接运行 npx @fce/design-md、pnpm dlx @fce/design-md,或者全局安装后执行 design-md。
English: After publishing, other users can run npx @fce/design-md, pnpm dlx @fce/design-md, or install it globally and execute design-md.
