Git Product home page Git Product logo

Comments (3)

jaywcjlove avatar jaywcjlove commented on June 25, 2024

// 命令名称
json["n"] = title;
// 命令路径
json["p"] = `/${path.basename(mdPath, '.md').replace(/\\/g, '/')}`;
// 命令描述
let des = str.match(/\n==={1,}([\s\S]*?)##/i);

有一些规则,你可以直接用

  • 命令名称,就是文件名,也可以文档中匹配出来
  • 命令描述,也可以从文档中匹配出来

```markdown
CommandName
===
作为代码规范文档进行展示
## 补充说明
**CommandName命令** 是用于演示的文档

@conglinyizhi 更多的元信息,我建议如下方法添加到 .md 文本的最底部,这种方式,将在 GitHub 中忽略展示,不会影响现在所有内容

<!--
date: "2023-05-24"
source: "https://www.gnu.org/software/bash/"
install: "sudo apt-get install bash"
supported_linux_systems:
  - Ubuntu
  - Debian
  - Fedora
  - CentOS
-->

开发使用

可以通过 npm 安装 linux-command 包,包含所有命令的 markdown 文本,和一个索引文件

npm install linux-command
var comm = require("linux-command");
console.log("---->", comm.ls);

var alias = require("linux-command/command/alias.md");
console.log("---->", alias); // markdown string

你也可以通过 CDN 来访问索引数据,和对应的命令详细内容,我将更新内容定期发布版本,提供大家使用,UNPKG 带上版本号,将锁定版本访问,删除版本号请求数据,将会自动重定向最新版本。

# 命令索引 JSON 数据
https://unpkg.com/linux-command/dist/data.json
# 对应命令详情(Markdown)数据
https://unpkg.com/linux-command/command/<命令名称>.md

你也可以通过 Github 的 Raw 来,获取最新的内容

# 命令索引 JSON 数据
https://raw.githubusercontent.com/jaywcjlove/linux-command/master/dist/data.json
# 对应命令详情(Markdown)数据
https://raw.githubusercontent.com/jaywcjlove/linux-command/master/command/<命令名称>.md 

from linux-command.

conglinyizhi avatar conglinyizhi commented on June 25, 2024

好吧,我本来是希望元数据代替三个等号作为命令描述的,看起来您似乎不愿意实现这些

顺带一提,如果希望做国际化的话,我找到了一个翻译网站,可以用来托管需要翻译的项目 https://hosted.weblate.org/hosting/ 不过我建议提前对国际化进行准备

from linux-command.

jaywcjlove avatar jaywcjlove commented on June 25, 2024

image

@conglinyizhi 目前这种方式迎合 GitHub 的自带预览功能,所以添加**“元数据”**尽量使用 注释语法添加

对国际化目前没有想法,因为英文版本(#21)有更多更好的工具,例如:https://github.com/tldr-pages/tldr

from linux-command.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.