uclouddocs / docs_new

新平台的使用指南

开始使用Github创作您的UCloud Doc

【新功能发布日志】

发布日期	发布内容	使用说明	发布人
2019-12-03	左边栏支持添加产品icon	前往查看	李安
2020-01-13	功能更新：支持自由发布	前往查看	李安
2020-01-13	功能更新：支持更多语言高亮	前往查看	李安
2020-01-13	功能更新：支持tabs样式	前往查看	李安
2020-01-15	指南更新：提供markdown模版	前往查看	李安
2020-06-28	功能更新：支持智能“词汇表”	前往查看	李安

---

快速阅读

• 快速上手 UCloud Docs

  • 4步上手文档中心！
  • 可复制的markdown模版

• 常见问题

  • 如何使用超链接
  • 合理使用Tips样式
  • 更多语法支持高亮
  • 平台支持Tabs
  • 左侧导航目录缺失？
  • 如何自定义文章排序

• 完全新手？我第一次用github/第一次写文档

  • 【推荐阅读】《助你5步创建技术文档》
  • PD如何管理仓库？
  • 第一次用github写文档？
  • 有没有推荐的md编辑器？

• 意见收集：若您对指南的内容有更好的意见和建议，欢迎告诉我们

  点击此处提交反馈

• 维护人员

  • 产品文档维护及发布：由产品文档负责人们分管
  • API文档维护：徐晓路
  • 平台导航维护及发布：李安
  • Github建仓：冯业浩
  • Github仓库管理员维护：李安

---

4步上手文档中心

Step1:注册账号、申请仓库

使用ucloud邮箱注册github账号 >>> 联系主仓库的管理者冯业浩新建仓库 >>> 查收邀请邮件，前往仓库

详细内容>>

Step2:开始写文档

1. 查看产品文档仓库/API文档仓库 仓库列表>>

2. 了解仓库内容结构 仓库内容详解>>

1. _sidebar.md：用于控制左侧目录
2. overview.md：建议仓库提供的概览页，方便创作者对外分享也方便用户整体概览
3. images文件夹：用户存储所有文档用，引用方式如下：
![图片注释](/images/图片.png)
		
4. 文件夹/markdown文件：各层级关系的文档

Step3:实时预览文档前往

我们支持实时预览。仓库内的变更都可以实时在发布页面上点击“前往预览”进行查看。

Step4:自由发布

发布地址：点击这里

常见问题：

Q：为什么我没有发布权限？

A：请确认以下几点：

• 是否对仓库具有master权限。没有？联系平台PD
• 是否公开注册邮箱？
• 账号的Primary邮箱是否是UCloud注册邮箱？
• 是否完成一次 commit

---

附录_可复制的markdown模版

• _sidebar.md
• overview.md
• tabs标签模版
• 收起展开html语法

_sidebar.md

<div class="sidebar_title icon__uhost"> 云主机 UHost</div>                 <!-- 产品名称+icon -->
<!-- 空行不要删除！！！ -->           <!-- 空行不要删除！！！ -->            <!-- 空行不要删除！！！ -->
* [概览](/uhost/README)
* 产品简介
    * [什么是云主机](/uhost/introduction/concept)                  <!-- 层级缩进=4个空格 -->
    * [产品优势](/uhost/introduction/advantages)
    * [功能简介](/uhost/introduction/functions)
    * [计费说明](/uhost/introduction/charge)
    * 主机
        * [地域与可用区](/uhost/introduction/uhost/az)
        * [机型与CPU平台](/uhost/introduction/uhost/type_new)
        * [特性](/uhost/introduction/uhost/feature)
        * [订单构成](/uhost/introduction/uhost/lifecycle)
        * [配额](/uhost/introduction/uhost/quota)
        * [机型与规格](/uhost/introduction/uhost/type)

README.md

# 概览
* 产品简介
    * [什么是云主机](/uhost/introduction/concept)         <!-- 若写目录，可直接复制sidebar -->
    * [产品优势](/uhost/introduction/advantages)
    * [功能简介](/uhost/introduction/functions)
    * [计费说明](/uhost/introduction/charge)
    * 主机
        * [地域与可用区](/uhost/introduction/uhost/az)
        * [机型与CPU平台](/uhost/introduction/uhost/type_new)

概览页只能写目录？

当然不是，平台只是给出最低配的建议，以方便那些需要对外分享文档目录的创作者。平台非常希望广大创作者发挥自己的才智，使用md语法和平台提供的丰富样式来构建更有价值的概览页。

词汇表

若想在文档中创建产品文档词汇表，步骤如下：

1. 在仓库根目录下创建一篇文档，命名为“_glossary.md”
2. 文档格式，请参照下面模版
3. 若其他文档中使用到词汇表中关键词，请在该关键词前后各加一个空格（如“ 云主机 ”）。发布后，该关键词将自动生成词汇链接，点击后方可跳转至词汇表中对应关键词解释。

# 词汇表

## 词汇1

此处写词汇1的解释。发布成功后，文档中若包含词汇1，则会自动给该词汇增加超链，点击后跳转至本篇文档、本词汇解释内容。


## 词汇2

词汇2解释


## 词汇3

词汇2解释



## 词汇4

词汇2解释

Tabs标签模块

<!-- tabs:start -->

#### ** 第一个标签的标题 **

第一个标签的内容：

* 标题1
* 标题2

#### ** 第二个标签的标题 **

第二个标签的内容：

* 标题1
* 标题2

#### ** 第三个标签的标题 **

第三个标签的内容：

* 标题1
* 标题2
  <!-- tabs:end -->

收起展开html语法

<details>
  <summary>点击时的区域标题</summary>
​```
这是折叠的代码1
这是折叠的代码2
​```
</details>

【demo】

点击查看

我是详情内容

------

【参考资料】

Md语法说明

范例_ULB文档

Github简明教程