Skip to main content

用于管理我的个人 Foam 工作区的脚本集合

项目描述

Seckerwiki 脚本

这个包是一个 CLI,可以帮助我管理基于 markdown 的Foam工作区,或者我的“个人 Wiki”。我将所有内容都存储在我的 wiki 中,从日记条目到 uni 笔记。

安装

版本1.x需要额外的依赖才能使讲座到降价转换器正常工作。由于我不再去uni,我不再需要那些脚本,所以安装很简单:

pip3 install seckerwiki

安装后,运行以下命令生成配置文件:

wiki setup

命令

设置

这个命令做了几件事:

  • 在 中创建一个config.yml文件~/.config/seckerwiki,用于在 repo 中配置一些东西。
  • 在 中创建一个credentials文件~/.config/seckerwiki/,其中存储机密。

编辑凭证文件以添加用于解密日志的秘密密码(见下文)。

日志

git log 的别名,带有一些漂亮的图形选项。

地位

运行git status。基本上只是一个方便的功能,所以你不必cd进入维基目录。

犯罪

执行 git 提交,生成提交消息。如果有许多暂存文件,则提交标头会显示顶级文件夹。

参数:

  • -y: 跳过验证并提交
  • -a: 也做git add --all

同步

然后执行git pull(变基)git push

杂志

我使用我的 wiki 来存储加密的日记条目。

运行wiki journal以在设置中指定的日志文件夹中生成一个新的空日志条目。wiki journal --encrypt用文件替换所有.md文件.md.asc,使用设置中指定的对称密钥加密文件。wiki journal --decrypt [filename]解密加密日志目录中的文件并将其打印到标准输出。

目录

为降价文件所在的其他文件/子文件夹生成目录。

将以下标签添加到每个子文件夹中的“contents/readme”页面:

<!--BEGIN_TOC-->
<!--END_TOC-->

该脚本将用内容替换这两个标签之间的内容。例如:

<!--BEGIN_TOC-->
Pages:
- [hardware](./hardware.md)
- [iot-development](./iot-development.md)
- [iot-platforms](./iot-platforms.md)
- [platformio-esp32-notes](./platformio-esp32-notes.md)
- [rtoses](./rtoses.md)

<!--END_TOC-->

这主要用于Foam可以构建一个图形,该图形通过一个节点将文件夹内的页面收集在一起。

统计数据

打印一些关于 wiki 的酷统计数据:

  • commits made- 自 repo 创建以来的 git 提交次数
  • Number of notes- 回购中的降价文件数量
  • total lines.md-文件中的非空行
  • largest files- 前 3 个最长.md文件的路径

发展

我使用诗歌来构建/发布包。阅读他们的文档。

下载文件

下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。

源分布

seckerwiki-2.0.12.tar.gz (12.9 kB 查看哈希)

已上传 source

内置分布

seckerwiki-2.0.12-py3-none-any.whl (15.1 kB 查看哈希

已上传 py3