CMT_CS_Learning icon indicating copy to clipboard operation
CMT_CS_Learning copied to clipboard

关于对每篇文章添加作者、标题及其他有用信息的提案

Open Y334275 opened this issue 4 years ago • 3 comments

由于目前的文章是以目录层级来区分的,但是在 a 文章中,可能添加一个 b 文章的链接,此时,在 a 文章中点击链接跳转到 b 文章并不能十分清晰的看出这是哪一篇文章,因此建议加上文章标题信息。

对于其他信息,我个人认为有一点十分重要:

  1. 作者,写这篇文章的人,如果是多人完成,就多个作者,作者名可以是一个昵称,加作者的目的是为了读者了解文章贡献者,方便有问题联系,哪怕联系不到,但是我认为这个功能要提供出来。

添加文章标题与作者两个部分还可以帮助文档项目 cmt-cs-learning-website 的开发,其他的有需要添加的内容可在评论区探讨一下。

Y334275 avatar May 27 '21 15:05 Y334275

补充:在每篇文章的文件开头,加入类似图片所示的 markdown 代码 image 然后填充所需要的信息

Y334275 avatar May 28 '21 00:05 Y334275

经商议,目前确定需要填充的信息有: 1. 标题 2. 作者 3. 日期 4. 内容摘要

jianm-xs avatar May 28 '21 01:05 jianm-xs

标题、作者、时间戳是必选项,摘要列为可选项,而且列摘要意义不大,其余信息在README说明即可

sunlingbot avatar May 28 '21 04:05 sunlingbot