非常简单的静态网站网址缩写
sus的Python项目详细描述
sus是一个基于静态站点的URL缩短器。 简单的想法:生成一个静态站点 redirect-slug-goes-here/index.html文件,其中只有一个HTML重定向。在
^{1}$安装
# note: you’ll need Python 3.6 or higher
pip install sus
使用
- 安装程序包
- 准备好input文件
- 准备好home.html文件(可选)
- 在与input相同的目录中运行sus
- 你的结果在output/目录中
输入
sus期望在当前目录和每一行中找到一个名为input的文件 由重定向段和目标URL组成,用管道(|)分隔。在
例如
^{pr2}$如果要在https://sus-example.nkantar.com上提供output/,那么 https://sus-example.nkantar.com/nk将重定向到https://nkantar.com并且 https://sus-example.nkantar.com/sus将重定向到 https://github.com/nkantar/sus。在
该示例站点存在,其存储库可以在 https://github.com/nkantar/sus-example.nkantar.com。在
主页
如果sus在input旁边找到一个home.html文件,它将把它复制到 output/index.html,从而生成一个主页。 如果没有,它将继续下去。在
发音
围绕项目名称的发音(不,它)引发了很多争议 没有)。 正因如此,这里有一个权威的指南,正如原作者所设想的那样。 请注意,很像 GIF -其他人可能有不同的想法,谁能说作者知道他在说什么 不管怎么样?在
在这种情况下,“sus”读作“可疑”,并且 Wiktionary帮助提供 以下指南:
发展
默认情况下,项目使用Poetry,和make install 应该让你开始运行所有的开发依赖关系。 之后,为了方便起见,请查看其他make命令。 它们对应于合并更改所需的CI检查。在
main分支是最前沿的版本。 Git tags对应于发布。在
投稿指南
各种各样的贡献都是受欢迎的,无论是bug报告、补丁,甚至只是 反馈。 创建new issue或 pull request可能是获得 起动。在
请注意,此项目发布时带有 Contributor Code of Conduct。 通过参与这个项目,你同意遵守它的条款。在
许可证
这个项目是由麻省理工学院授权的。有关详细信息,请参阅LICENSE文件。在
- 项目
标签: