storage-db/tooldiy

一本工具指南和开箱即用配置，旨在让大家选用和上手合适的工具。

ToolDiy

English | 简体中文

🤔 前言

工欲善其事，必先利其器。 ———《论语·卫灵公》

如果该项目使你受益，你可以在你的项目中添加 徽章

⛏ 贡献

我们非常欢迎各种的 PR 请求（包括但不局限于添加一个换行增加阅读体验），_(:з)∠)_本项目还处于初期阶段，非常需要各位大佬的完善和纠错。

如果你有已经写好的文章想要添加到这里，你可以通过下列方式：

1. fork 本仓库，在 mkdocs.yml 中添加 nav，并在 docs 下添加内容，提出 PR 以便进行合并。
2. 联系 SakurajimaMaii ，将文档的中文和英文版发送至他的邮箱 Email 。

文档采用 MKDocs 来编辑及部署，采用 Material for MKDocs 主题。

🤳 联系我们

点击链接加入群聊 tooldiy

💫 特别鸣谢

📑 许可证

本作品采用知识共享署名-相同方式共享 4.0 国际许可协议进行许可。

tooldiy's Issues

增加工具的易用性，考虑做好脚本和docker环境搭建让一些工具真正的开箱即用。目前以系统能力赛和一些开发板作为最紧迫的工作。

代码没有复制按钮，建议修改一下设置，方便复制。

设置方法如下：

theme:
  features:
    - content.code.copy

软件分类

软件类下面细化一下分区，编辑器，视频软件啥的

Feature Request: 建议自动生成导航

发现导航菜单需要手动生成。比较麻烦。

• 可以做一个 Action，或者看看有没有已有的 Action，在 Build 前生成菜单

Markdown删除线显示错误

小问题，NavEntryNotFound

INFO     -  Building documentation...
INFO     -  Setting the default 'theme.language' option to 'zh'
WARNING  -  Language 'zh' is not supported by lunr.js, not setting it in the    
            'plugins.search.lang' option
INFO     -  Adding 'en' to the 'plugins.search.lang' option
INFO     -  Cleaning site directory
INFO     -  NavEntryNotFound: Nav entry "index.en.md" not found.
            [C:\Users\Snowy\Documents\GitHub\ToolDiy\docs\.pages]
              File
            "D:\Software\Scoop\apps\python\current\Lib\site-packages\mkdocs_awesome_pages_plugin\navigation.py",
            line 127, in _nav
                result = _make_nav_rec(meta.nav)
              File
            "D:\Software\Scoop\apps\python\current\Lib\site-packages\mkdocs_awesome_pages_plugin\navigation.py",
            line 124, in _make_nav_rec
                warnings.warn(warning)
INFO     -  NavEntryNotFound: Nav entry "pr.en.md" not found.
            [C:\Users\Snowy\Documents\GitHub\ToolDiy\docs\specification\.pages] 
              File
            "D:\Software\Scoop\apps\python\current\Lib\site-packages\mkdocs_awesome_pages_plugin\navigation.py",
            line 127, in _nav
                result = _make_nav_rec(meta.nav)
              File
            "D:\Software\Scoop\apps\python\current\Lib\site-packages\mkdocs_awesome_pages_plugin\navigation.py",
            line 124, in _make_nav_rec
                warnings.warn(warning)
INFO     -  NavEntryNotFound: Nav entry "template.en.md" not found.
            [C:\Users\Snowy\Documents\GitHub\ToolDiy\docs\specification\.pages] 
              File
            "D:\Software\Scoop\apps\python\current\Lib\site-packages\mkdocs_awesome_pages_plugin\navigation.py",
            line 127, in _nav
                result = _make_nav_rec(meta.nav)
              File
            "D:\Software\Scoop\apps\python\current\Lib\site-packages\mkdocs_awesome_pages_plugin\navigation.py",
            line 124, in _make_nav_rec
                warnings.warn(warning)
INFO     -  Translated default navigation to zh
INFO     -  Translated navigation to zh
INFO     -  NavEntryNotFound: Nav entry "index.md" not found.
            [C:\Users\Snowy\Documents\GitHub\ToolDiy\docs\.pages]
              File
            "D:\Software\Scoop\apps\python\current\Lib\site-packages\mkdocs_awesome_pages_plugin\navigation.py",
            line 127, in _nav
                result = _make_nav_rec(meta.nav)
              File
            "D:\Software\Scoop\apps\python\current\Lib\site-packages\mkdocs_awesome_pages_plugin\navigation.py",
            line 124, in _make_nav_rec
                warnings.warn(warning)
INFO     -  NavEntryNotFound: Nav entry "pr.md" not found.
            [C:\Users\Snowy\Documents\GitHub\ToolDiy\docs\specification\.pages] 
              File
            "D:\Software\Scoop\apps\python\current\Lib\site-packages\mkdocs_awesome_pages_plugin\navigation.py",
            line 127, in _nav
                result = _make_nav_rec(meta.nav)
              File
            "D:\Software\Scoop\apps\python\current\Lib\site-packages\mkdocs_awesome_pages_plugin\navigation.py",
            line 124, in _make_nav_rec
                warnings.warn(warning)
INFO     -  NavEntryNotFound: Nav entry "template.md" not found.
            [C:\Users\Snowy\Documents\GitHub\ToolDiy\docs\specification\.pages] 
              File
            "D:\Software\Scoop\apps\python\current\Lib\site-packages\mkdocs_awesome_pages_plugin\navigation.py",
            line 127, in _nav
                result = _make_nav_rec(meta.nav)
              File
            "D:\Software\Scoop\apps\python\current\Lib\site-packages\mkdocs_awesome_pages_plugin\navigation.py",
            line 124, in _make_nav_rec
                warnings.warn(warning)
WARNING  -  Documentation file 'frame/wasm-bpf.md' contains a link to
            'frame/README_zh.md' which is not found in the documentation files.
INFO     -  Building zh documentation
WARNING  -  Documentation file 'frame/wasm-bpf.md' contains a link to
            'frame/README_zh.md' which is not found in the documentation files.
INFO     -  Building en documentation
WARNING  -  Documentation file 'frame/wasm-bpf.en.md' contains a link to
            'frame/README_zh.md' which is not found in the documentation files.

I am against allowing paid softwares to be included in the recommend list.

Paid softwares in the recommend list are just advertiment. This should not be allowed to add to this project.

社区 pull request 规范相关问题

个人建议可以在 pull request 规范中添加新的规范类型 docs 专门用于文档上传者的提交，否则在对于本仓库可能需要进行的回溯过程中可能出现不影响网站主体内容更新的文档提交影响了在可能影响网站主体内容更新的 feat 中寻找问题时的效率。

提供一种大陆友好型的页面访问方式

主要面对国内不同专业领域的用户，应当考虑非程序员能否简单快速的浏览我们的主页上的内容。

起草社区评论规范

我觉得有必要起草一个规范来保证社区良好的氛围

开设实用的工具类网站分区

考虑为网页增设一个分区吗？

目录导航改为自动生成

我自己用的配置，效果还行

site_name: 计算机学科笔记
theme:
  name: material
  features:
    # - announce.dismiss
    - content.code.annotate
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.indexes
    # - navigation.instant
    # - navigation.prune
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

LaTeX文档希腊字母大写显示有问题

关于提升阅读体验

1. 将默认 README 改为中文或许会观感更好（另一方面，目前中文版 README 更详细写了如何 PR，英文版还没同步）。
2. 建议在“如何贡献”中添加：尽量遵循中英混排规范。
3. 可以增加 template.md 和 template.en.md，以提醒大家更醒目标注一些标签信息（如：可使用平台、是否收费）、优缺点、适用场景、备注。
4. 建议在 README 中添加：如果修改了原有目录结构请询问管理员。因为如果不修复 discussion 名可能会丢失原有评论。