CODE新增文档项目功能 打造技术文档知识库!

    学习一项新技术或者一个新项目,最头疼的是什么?当然是没有足够的文档资料!

    往往越是新兴的技术/项目,其文档资料越是不够完善、不够条理,还有很多国外的优秀项目也由于缺少足够的中文文档而很难在国内推行开。

    为了帮助开发者解决这一难题,CSDN CODE新增了“文档项目”这一功能,旨在从技术上为项目文档的建立和充实提供先决条件,从运营上努力帮助开发者们促成项目资料的整理、整合和翻译等工作,与开发者们一起努力打造业界最完备的开发技术知识库。

    我们先来看看CODE上“文档项目”功能都有哪些特点:

  • 使用git进行版本管理

    文档项目首先是一个git版本管理的项目。它具备其他一切git版本管理项目的优点。诸如可以进行历史版本管理,可以本地克隆、可以派生、提交和处理合并请求等。这部分无须赘述。

 

  • 在线处理合并请求、解决冲突

    文档项目目前与CODE上其他git版本项目一大不同是,它可以在线处理合并请求、在线解决冲突。这是非常实用和高效的一种社交编程处理方式,据我们所知,连github也尚不能提供在线解决冲突的功能。

    下图是一个在线解决冲突的案例:

        点击合并之后,有冲突的内容会整个以粉色底色标示出来,你需要仔细检查并矫正其中的冲突。矫正完成需要保存的时候,记得把文件头部的“<<<<<<<” 和尾部“>>>>>>> ”标识的语句删除。

 

  • 所见即所得的markdown编辑器

    CODE文档项目支持markdown语言高亮显示,通过所见即所得的markdown编辑器,你可以很高效的完成文档编辑工作,傻瓜化操作,易于修改。Markdown是业界非常流行的轻量级文本标记语言。它非常简单易学,并能满足技术文档编辑的大多数需求。

在线编辑效果如图:

  • 文档目录自动生成

    CODE文档项目可自动提取文本中的标题标签自动为该文档生成树形目录。目录将提取一至三级标题,其中一级标题全部罗列展示,二三级可折叠显示。点击标题前面的“+”号即可查看下一级标题的内容。效果如图:

  • 保存时显示更改内容

    每当你编辑完一个文档项目点击保存时,在保存结果页面将会显示当前文档与上一版本的不同,其中绿色显示的是新增内容,红色是删除和更改的内容。你将很容易的了解到项目的变动情况,并能及时发现错误。

  • 全屏、全功能、简洁三种显示模式

   默认情况下CODE文档项目以简洁模式呈现,常用的工具菜单栏悬浮在页面右侧,把更多的空间留给文字内容本身。当你想要使用更多功能时,可以点击项目标题右侧的收起图标(如图),展开git版本管理相关的工具栏。你也可以随时通过全屏按钮切换为全屏阅读模式。

图:简洁模式

图:全功能模式

图:全屏模式

 

  • 查看和启用项目历史

​    在项目“历史”菜单下,你可以查看该文档项目的所有提交历史。如果你想将项目恢复到之前的某个版本,只需要选中该次提交历史,点击“启用”即可。如果后悔了,只需要重新启用恢复前的最新版本即可——也就是说,启用历史并不会将现在的内容完全覆盖哦~

  • 比较任意两个历史

    想要知道两次历史提交间的不同?你只需要勾选这两个版本,然后点击“比较”按钮,就可以了。两个版本间的内容差异将会被以红绿色块标示出来,页面上方的统计信息还会告诉你这两者之间共有多少处改动。(如图)​

  • 给历史添加版本信息

    为了更加方便的管理文档,你可以为每次提交历史添加版本信息。添加版本信息后,在“历史”查看界面,你还可以选择“按版本查看”来筛选有版本信息的所有文件。​

图:添加版本信息

图:筛选有版本标签的历史

 

    以上就是CODE文档项目功能的基本特点介绍,更多的细节和体验,更多操作介绍,包括如何创建和管理一个文档项目,请查看这里的帮助文件

    使用文档项目过程中如果有什么更好的想法和建议,欢迎随时向我们提交反馈!

    另外,我们非常欢迎各位热心的开发者将您收集到的项目资料以文档项目的形式共享到CODE上来,CODE愿意在此过程中提供一切力所能及的帮助,让我们一起将开发文档知识库完善起来,让更多的读者、开发者受益!