如何使我的Perl模块的README文件与Github的Markdown显示兼容？

发布时间：2020-12-15 21:14:12 所属栏目：大数据来源：网络整理

导读：我在Markdown的Perl模块中创作了README文件. Github将此README文件视为纯文本.我尝试将文件重命名为“README.md”,这在Github上看起来不错,但Perl工具看不见名为“README”的文件. 有没有什么方法可以同时拥有一个README文件,并且我的Markdown格式被Github正

我在Markdown的Perl模块中创作了README文件. Github将此README文件视为纯文本.我尝试将文件重命名为“README.md”,这在Github上看起来不错,但Perl工具看不见名为“README”的文件.

有没有什么方法可以同时拥有一个README文件,并且我的Markdown格式被Github正确解释？

我可以想出的唯一选择是拥有README和README.md,但我不希望手动保持两个文件同步.

谢谢你的帮助.

解决方法

在pod中格式化README,将其重命名为README.pod,然后再将其改为 works两个地方！ Example

为了我的目的,我实际上只是从主pod生成我的README.pod

$podselect lib/My/Main/Module.pm > README.pod

一个叫做外部链接的警告不正确L< GitHub | http：//github.com&不幸的是指向search.cpan.org寻找一个GitHub模块.我试图通知他们这个故障,但它让我无处不在.相反,您可以使用简单的外部链接(即GitHub：L< http：//github.comu0026gt;),并且它们工作正常. 好消息,自从我上次检查以来,他们似乎已经修复了！只是一个问题,Perl工具链的哪些部分需要README文件？如果您的意思是将其包含在您的tarball中,请确保将文件添加到您的MANIFEST中,并将其包含在内.

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!