前言
Gist 是 Github 上一个非常实用的功能,可以用来共享代码片段。Gist 有自己的 url,而且可以被搜索引擎收录。 很多开源项目文档上面也用 Gist 来嵌入代码示例。
然而,使用 Gist 并不是很方便,需要人工复制粘贴,还需要登录 Github。如果我们希望更方便地管理 Gist,那么我们可以使用 npm 包 gist-studio。
简介
gist-studio 封装了 GitHub API,提供了一个命令行界面,让我们可以非常方便地操作 Gist。使用 gist-studio,我们可以快速创建、编辑、删除 Gist,同时也可以对 Gist 进行标记和搜索。
安装
我们可以使用 npm i -g gist-studio 命令进行全局安装。安装成功之后,我们可以使用 gist-studio 命令来调用该工具。
使用
创建 Gist
首先,我们需要使用 create 命令来创建 Gist。 我们可以使用 -d 选项来指定描述,-f 选项来指定文件名,-c 选项来指定代码。(-p 选项可以指定是否为私有 Gist)
gist-studio create -d 'example gist' -f 'example.js' -c 'console.log("hello world")'
如果我们想要创建一个多文件 Gist,可以指定多个 -f 和 -c 选项:
gist-studio create -d 'example multi-file gist' -f 'file1.js' -c 'console.log("hello world 1")' -f 'file2.js' -c 'console.log("hello world 2")'
编辑 Gist
如果我们想要编辑 Gist,可以使用 edit 命令。我们需要指定 Gist ID,然后使用 -f 选项指定要编辑的文件名,-c 选项指定修改后的代码。如果我们想要删除某个文件,可以在 -f 选项后面加上 -rm 参数。如果要添加新文件,可以使用 -nf 和 -nc 选项。这些命令的使用方式可以如下所示:
# 修改文件内容 gist-studio edit GIST_ID -f 'example.js' -c 'console.log("hello world again!")' # 删除文件 gist-studio edit GIST_ID -f 'file1.js' -rm # 添加文件 gist-studio edit GIST_ID -nf 'new_file.js' -nc 'console.log("this is a new file!")'
删除 Gist
如果我们想要删除 Gist,可以使用 delete 命令。我们需要指定 Gist ID,然后输入 y/n 确认删除。
gist-studio delete GIST_ID
搜索 Gist
如果我们想要搜索 Gist,可以使用 search 命令。我们可以使用 -t 选项指定搜索关键字。可以添加 -p 参数来只搜索自己的私有 Gist,或者添加 -u 参数来只搜索指定用户的 Gist。
# 搜索所有公共 Gist 中包含 "example" 关键字的 Gist gist-studio search -t 'example' # 搜索所有自己的 Gist 中包含 "example" 关键字的 Gist gist-studio search -t 'example' -p # 搜索用户名为 "example" 的用户的所有 Gist gist-studio search -t 'example' -u 'example'
列出 Gist
如果我们想要列出自己的 Gist,可以使用 list 命令。
gist-studio list
以上就是 gist-studio 详细的使用教程了。通过这个工具,我们可以更方便地管理自己的 Gist,而不需要亲自到 Github 上进行操作。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055af181e8991b448d899a