Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

讨论一些问题，欢迎参与 #118

Open
ZhuangZhu-74 opened this issue Jun 12, 2019 · 24 comments
Open

讨论一些问题，欢迎参与 #118

ZhuangZhu-74 opened this issue Jun 12, 2019 · 24 comments
Labels
讨论

Comments

@ZhuangZhu-74
Copy link
Collaborator

今天有空仔细看了一边README文档，作为pr提交者之一想和大家讨论一些问题。

  • linuxde.net 我之前学命令时也常去，不过最近确实不更新了。这项目可以对原有的一些问题，比如过时的内容、错字等进行修改，在此对发起及维护者的热情和无私表示感谢；）

  • 是否有必要设置一个标准的linux版本作为帮助信息来源的标准？linux版本不同，相应的帮助信息也会有出入。

  • 是否有必要在显著位置提示用户帮助信息可能与您实际查看的帮助信息有出入

  • 有些收录的命令是bash内建命令，比如help，builtin等。是否考虑分离它们作为单独的一部分进行维护。还是分别为它们标明是bash内建命令？有的特殊内建命令（比如 . : [）可能创建不了文件。
@jaywcjlove
Copy link
Owner

@ZhuangZhu-74

这个工作量有点大，不过可以将一些点列出来一点点的优化。

现在有500多个文件，比如之前标准化一下 markdown 排版，我搞了一宿

现在其实有一些需求和问题。

  1. 如何处理 命令 版本的问题，在维护的过程中，发现，同一个命令，不同渠道，不同平台，帮助信息都不是一致的，这个问题也是也不大，做的好一点，要显示过时的参数或者标识只在哪些平台起作用等

  2. 有人提出，翻译成英文 English version #21 ，这个工作量太大，我英语水平也太次，其实人多也不是不可以，但是首先要标准化 Markdown文档格式，方便批量生成。

有一些计划想做的内容

标识命令 兼容平台，内建命令，Mac通用，需要安装

这个工作量也很大

初步设计目标

  • 不影响 GitHub 中阅读
  • 方便生成 HTML
  • 方便维护（添加标识）

想在每个 markdown 文件的顶部加段注释，来配置命令标识，配置以 YAML 1.2 格式来定义，如：

<!--
Support: 
  - mac
  - centos

Install:
  - 'yum install <name>' 
  - 'brew install <name>'

Built-in: true
-->

@ZhuangZhu-74
Copy link
Collaborator Author

@ZhuangZhu-74

这个工作量有点大，不过可以将一些点列出来一点点的优化。

现在有500多个文件，比如之前标准化一下 markdown 排版，我搞了一宿

现在其实有一些需求和问题。

  1. 如何处理 命令 版本的问题，在维护的过程中，发现，同一个命令，不同渠道，不同平台，帮助信息都不是一致的，这个问题也是也不大，做的好一点，要显示过时的参数或者标识只在哪些平台起作用等
  2. 有人提出，翻译成英文 English version #21 ，这个工作量太大，我英语水平也太次，其实人多也不是不可以，但是首先要标准化 Markdown文档格式，方便批量生成。

有一些计划想做的内容

标识命令 兼容平台，内建命令，Mac通用，需要安装

这个工作量也很大

初步设计目标

  • 不影响 GitHub 中阅读
  • 方便生成 HTML
  • 方便维护（添加标识）

想在每个 markdown 文件的顶部加段注释，来配置命令标识，配置以 YAML 1.2 格式来定义，如：

<!--
Support: 
  - mac
  - centos

Install:
  - 'yum install <name>' 
  - 'brew install <name>'

Built-in: true
-->

@jaywcjlove

谢谢！

  • 现在我觉得可以先把文档现有的错误（语法，阅读通顺）改过来，然后再调模板。

@jaywcjlove
Copy link
Owner

@ZhuangZhu-74 这个可以大家发现，慢慢 改，是一个持久的过程，我使用的时候，看到错误，我也会去更改。

@jaywcjlove jaywcjlove pinned this issue Jun 21, 2019
@ZhuangZhu-74
Copy link
Collaborator Author

我刚才更新了pwd命令，格式可能需要你再优化一下 @jaywcjlove

jaywcjlove added a commit that referenced this issue Aug 29, 2019
@jaywcjlove
Update pwd.md #118
dcca140
@jaywcjlove
Copy link
Owner

@ZhuangZhu-74 更新了一下。

@ZhuangZhu-74
Copy link
Collaborator Author

我已经看了更新后的文档，那么这种样式就可以做为以后处理同名问题的模板了。

@jaywcjlove
Copy link
Owner

@ZhuangZhu-74 目前没有想到更好的排版方式，暂时先就这样排版吧。

@ZhuangZhu-74
Copy link
Collaborator Author

@ZhuangZhu-74 目前没有想到更好的排版方式，暂时先就这样排版吧。

明白了。

@ZhuangZhu-74
Copy link
Collaborator Author

最近忙于处理个人事件，暂停更新，预计最晚明年春节后恢复更新，谢谢！

@jaywcjlove
Copy link
Owner

@ZhuangZhu-74 感谢一直疯狂更新，现在 gh-pages 通过 Actions 自动发布。

@lifeike
Copy link

lifeike commented Feb 5, 2020

这东西还是很精妙的, 有个要是,要是能做个把那个Alfred 做进Ubuntu 使用就好了........

@ZhuangZhu-74
Copy link
Collaborator Author

抱歉各位，由于最近新冠肺炎以及准备面试等要紧的事情没来得及更新文档，下个月开始会逐渐恢复。

@Jackiexiao
Copy link

感觉可以在首页添加如何使用linux自带的帮助来查看命令行的用法，比如对于 du 命令，可以用 man du 或者 du --help，养成良好的习惯

@ZhuangZhu-74
Copy link
Collaborator Author

感觉可以在首页添加如何使用linux自带的帮助来查看命令行的用法，比如对于 du 命令，可以用 man du 或者 du --help，养成良好的习惯

您好，
关于您提到的问题：

  1. 帮助信息通过搜索引擎可以找到，也可以通过本项目的网站查询获取（通常在 “注意” 段落）。
  2. 帮助信息不具有统一的通用型选项或手册。比如 -h 和 --help 这两个选项，对于 du 来说，前者用于输出人类可读的信息，而不是帮助信息；man info 均为手册命令，但只适用于那些附带了相应文档的命令。

@pplmx
Copy link
Contributor

pplmx commented May 18, 2021 •
edited
Loading

关于提交:

可以参考这个

Tools

CLi

https://github.com/commitizen-tools/commitizen

JetBrains Plugins

https://github.com/lppedd/idea-conventional-commit
https://github.com/MobileTribe/commit-template-idea-plugin

@dateolive
Copy link

搜索可以支持命令参数嘛，而不是跳转页面，我觉得这个功能应该挺常用的，如果支持了，可以提高比较大的便捷性

@WHG555
Copy link

WHG555 commented Jan 4, 2023

模板 可以发布一些模板 ，大家来讨论。

@conglinyizhi
Copy link
Contributor

@jaywcjlove 我希望未来使用 Github 的 discussions 进行讨论，而不是 issues ，这里更像是交流某单个问题的，而且解决问题关闭后会减少访问量

@y377
Copy link

y377 commented Oct 26, 2024

用VUE3和Jekyll重新设计HTML，效果会很好，另外提交一个没有的命令lsscsi

@jaywcjlove
Copy link
Owner

用VUE3和Jekyll重新设计HTML，效果会很好，另外提交一个没有的命令lsscsi

Jekyll + Vue 如何重新设计 HTML 呢？

@y377
Copy link

y377 commented Oct 31, 2024 •
edited
Loading

用VUE3和Jekyll重新设计HTML，效果会很好，另外提交一个没有的命令lsscsi

Jekyll + Vue 如何重新设计 HTML 呢？

我的设想是：

  1. 不同发行版，根据命令的差异（或者是特有命令，比如yum和apt）做成选项卡如
**centos** | **debian** | **ubuntu** | 更多
  1. 用vue的好事是点击一个命令不要重新打开网页，应该使用下拉弹出，鉴于有些命令选项太多，需要使用到异步加载（这块我还不太熟练）
  2. 直接将github的readme中的Linux命令分类在首页进行分组
  3. 余下的就是将命令详情页的CSS美化

要是有人愿意维护命令，我倒是可以用Jekyll（熟练）和vue3（一般）写个模板/主题。

我来尝试弄个吧，供作者参考，不过需要一些时间，VUE和Jekyll结合看似麻烦，实则也不简单

image

@jaywcjlove
Copy link
Owner

@y377 Jekyll 就是将 markdown 生成静态页面的工具，跟我的脚本差不多的意思，不太建议使用 vue 因为不利于 SEO，不然我早用 React 写了一遍

也不太适合服务端渲染，因为它是免费部署在 GitHub Page 上的纯静态服务 -> https://github.com/jaywcjlove/linux-command/tree/gh-pages

@conglinyizhi
Copy link
Contributor

那能否考虑使用 Nuxt.js 生成的静态文件呢？这会导致每次修改之后都需要编译一次

@jaywcjlove
Copy link
Owner

@conglinyizhi 你可以 fork 过去搞一版本，部署试一试，大家觉得可以合并进来

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
讨论
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
9 participants
@jaywcjlove @Jackiexiao @WHG555 @pplmx @conglinyizhi @lifeike @ZhuangZhu-74 @y377 @dateolive