文档写作及设置

最后更新于:2022-04-02 06:53:23

文档创建完成后,可以通过点击编辑按钮进入编辑模式。 ## 进入编辑模式 文档编辑一般有两个操作入口,在创建完成文档后,可以点击右上角的编辑按钮进行内容编辑,如图: ![](https://docs.gechiui.com/gc-content/uploads/sites/kancloud/d398fc3151a02a06c3b71417d2066c59_1190x474.png) 如果你当前位于我的文档列表页面的话,在我的文档列表中找到你需要编辑的文档,然后点击右侧的编辑按钮,点击就可以进行文档内容编辑工作了。 ![](https://docs.gechiui.com/gc-content/uploads/sites/kancloud/5b60c05da9d435cb1cd85289e2d90c49_1164x259.png) 进入编辑模式后,可以看到默认打开的是一个包含一个目录的空白文档。 ![](https://docs.gechiui.com/gc-content/uploads/sites/kancloud/359ddae7bbf1bdd90e4c305b6ab65a55_1173x773.png) 随便写一些内容,因为看云采用的是MarkDown格式的排版,左边是编辑区,右侧则是同步预览效果区,所以还是比较直观的。 ![](https://docs.gechiui.com/gc-content/uploads/sites/kancloud/5e7d921ed46a11fdb5d865f60e52e2c5_1204x680.png) ### 文档同步 完成当前内容编辑后会自动保存,但只有点击右上角的同步按钮![](https://docs.gechiui.com/gc-content/uploads/sites/kancloud/a270aee8927f8426431aac43c61ea7fe_49x45.png)才会同步修改的内容到版本库(当前没有内容需要同步到服务器的时候按钮呈灰色),后面会详细描述下编辑器的用法。 > 编辑模式下的任何更改必须遵循编辑-》同步-》发布后,才能更新在线阅读版本。 ### 文档历史 点击同步按钮右侧的![](https://docs.gechiui.com/gc-content/uploads/sites/kancloud/5076ba2c5b8be5601542ada50a3fbae5_42x37.png)按钮就可以查看当前内容的编辑历史记录,如图: ![](https://docs.gechiui.com/gc-content/uploads/sites/kancloud/dbee7c8cbda0fbbf6c9082d47d9d434c_1389x540.png) 历史记录窗口左侧会显示当前内容的编辑历史记录,点击即可在右侧查看差异内容。 ### 全文预览 如果你需要和阅读环境一样预览当前文档的编辑内容,可以使用右上角的全文预览按钮![](https://docs.gechiui.com/gc-content/uploads/sites/kancloud/a617a5e998454803937a98e7ca22e110_45x34.png)。编辑的内容必须先同步后才能实现全文预览。 ### 系统帮助 右侧的帮助按钮可以快速进入看云的帮助手册。 ## 文档相关设置 文档编辑页面右上角有一个下拉菜单,这里可以进行一些文档相关的设置。 ![](https://docs.gechiui.com/gc-content/uploads/sites/kancloud/46f6dcddde4d50fd96efdc05a63acb53_198x223.png) ### 文档概要 可以在文档概要里面添加文档的详细描述信息,会显示在阅读页面的概要中(一样使用`md`编码格式)。如图: ![](https://docs.gechiui.com/gc-content/uploads/sites/kancloud/b431792a595d3052116ac50abcdbd4f5_492x435.png) ### 封面设置 点击封面设置可以更换文档的封面图片, ![](https://docs.gechiui.com/gc-content/uploads/sites/kancloud/6813a0f89bd30bdf84bc20f3608764e0_809x422.png) 上传更改封面图片后,必须要进行同步以及发布操作后才能生效,由于封面图片有CDN缓存,生效需要一定时间,如果更换后长时间没有生效,请清下你的浏览器缓存。 >[danger] 推荐一个图书封面的在线制作工具 帮助你快速完成一个漂亮的书籍封面:[`Canva`](https://www.canva.cn/) ### 样式设置 可以用于自定义当前文档的阅读样式,并且只能修改内容主体部分(`article-body`)的样式,例如,你可以设置你的阅读内容里面的`H2/H3`,`pre`,`code`等元素的样式。 ### 目录设置 在目录设置中你可以对目录文件进行高级编辑,但一定要注意目录文件的规范,只能包含列表内容(支持多级),而且不能包含空行。 ### 文档设置 文档设置主要用于设置文档使用的一些主题和插件配置,一般情况下无需设置(注意不要随便安装一些不必要的插件,会影响阅读性能)。 ![](https://docs.gechiui.com/gc-content/uploads/sites/kancloud/205d2dba4f9e900c7bf1fb15b4d91c6c_942x592.png) ![](https://docs.gechiui.com/gc-content/uploads/sites/kancloud/18ae3223577f39834f1ddb5333eafad7_941x589.png) ## 编辑区域设置 任何时候可以点击右下角的![](https://docs.gechiui.com/gc-content/uploads/sites/kancloud/65d4ee0ecee381b8559173faa0c0aec5_45x45.png)按钮,进行编辑区域设置。 包括是否显示右侧的自动预览和左侧的目录栏,以及编辑模式的切换。 ![](https://docs.gechiui.com/gc-content/uploads/sites/kancloud/6bfa89fdbfa653f94e6653c87cc8f389_203x301.png) 默认情况下,编辑器使用的是MD编辑器(带自动预览功能),你可以点击切换到可视化编辑模式。 ![](https://docs.gechiui.com/gc-content/uploads/sites/kancloud/1f064ebc76edebc58314da2592b1331e_184x301.png) 如果你有任何问题和建议,也可以点击反馈建议随时反馈给我们。
';