Skip to content

Commit

Permalink
首次导入语雀帮助文档
Browse files Browse the repository at this point in the history
  • Loading branch information
grasilife committed Apr 25, 2018
0 parents commit 96af48d
Show file tree
Hide file tree
Showing 51 changed files with 1,907 additions and 0 deletions.
Empty file added README.md
Empty file.
55 changes: 55 additions & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
- [新人必读]()
- [语雀是什么?](about.md)
- [为什么选择语雀](why.md)
- [如何注册语雀?](how-to-register.md)
- [语雀安全吗?](safety.md)
- [企业空间]()
- [企业空间是什么?](what-is-enterprise-space.md)
- [如何开通企业空间?](how-to-get-an-enterprise-space.md)
- [如何添加企业成员?](how-to-add-enterprise-members.md)
- [如何绑定钉钉登录?](bind_dingtalk.md)
- [企业空间是否收费?](ia26rx.md)
- [有存储空间的限制吗?](sd92wv.md)
- [团队]()
- [团队是什么?](dn0q41.md)
- [如何新建团队?](create_team.md)
- [如何添加成员?](how-to-add-members.md)
- [使用团队讨论区](topics.md)
- [知识库]()
- [知识库是什么?](qqgezy.md)
- [如何新建知识库](gbdfpb.md)
- [如何转移知识库](cd5825.md)
- [如何收到知识库更新](like_book.md)
- [文档知识库]()
- [如何新建文档?](puqqw3.md)
- [如何设置目录](cpeo0y.md)
- [编辑器介绍](editor.md)
- [如何发布文档?](how-to-publish.md)
- [如何保存文档?](how-to-save.md)
- [如何在文章中插入图片?](rs0a17.md)
- [如何插入代码?](insert-codes.md)
- [如何恢复历史版本?](how-to-restore-a-history-version.md)
- [支持那些快捷键?](cg9hye.md)
- [支持 Markdown 语法吗?](lnobo9.md)
- [深入浅出可视化文档编辑器editor](dive-into-yuque-editor.md)
- [多人协作](cooperate.md)
- [编辑器]()
- [功能介绍]()
- [数学公式](editor-math.md)
- [PlantUML 图](editor-puml.md)
- [发布日志]()
- [0403 编辑器发布说明](editor-2.4.md)
- [画板知识库]()
- [什么是画板知识库?](rppabq.md)
- [Sketch 插件](koe3wi.md)
- [其他功能介绍]()
- [探索语雀知识,关注有趣灵魂](new-dashboard-and-explore.md)
- [常见问题](faq.md)
- [迁移工具]()
- [从 GitBook 仓库 / GitLab Wiki 导入到语雀](import-from-gitbook.md)
- [导出语雀文档为 GitBook 格式的本地文件](export-to-gitbook.md)
- [Confluence 迁移到语雀](import-confluence-to-lark.md)
- [其他]()
- [联系我们](contact.md)
- [反馈](feedback.md)
- [加入我们](http://yuque.com/yuque/jobs/join)
39 changes: 39 additions & 0 deletions about-us.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# 关于我们

### 我们的团队

> 每个人心中或多或少都有一个「产品梦」,语雀团队正是这样一群心怀「普惠知识产品梦」的追梦人。
> 「潇洒」是我们的行事基调:人人都是一份子,全员一起潇洒地 Designing、Coding、Creating。

我们是一支来自于蚂蚁金服集团怀揣着「产品梦」的[团队](https://xcloud.alipay.com/),立志打造一款简洁、美观、好用的知识创作分享与工具,让知识在语雀中产生、流转、沉淀,助力企业、团队、个人形成自己的知识资产。我们希望语雀成为人们创作和交流知识的方式。

### 我们的产品理念

* **安全可信任:**知识就是财富,我们承诺永不丢数据,保护私密数据不会被泄露或非法阅读及篡改;
* **宁缺毋滥:**产品功能力求精炼、实用,针对每个场景努力寻找最佳实现方式;
* **不打扰用户:**知识工作者非常需要一个不受打扰的环境,所以我们推崇 [平静设计](http://www.ituring.com.cn/book/1795) ,保证用户的注意力可以集中在创作和阅读上;


### 团队其他产品

* [Ant Design](http://ant.design/) - 一个 UI 设计语言
* [AntV](http://antv.alipay.com/zh-cn/index.html) - 数据可视化解决方案
* [云凤蝶](https://www.yunfengdie.com/intro) - 移动建站平台
* [Egg.js](https://eggjs.org/) - 为企业级框架和应用而生的 Node.js 框架


### 我们需要你

> 有产品心、对知识领域产品有着浓厚兴趣的有志青年

* **产品经理:**致力在知识领域创造一款优质产品
* **视觉 & 交互设计师**:探索知识产品的最佳 UI
* **运营**:运营知识社区,让优质内容可以持续生产和流转
* **可视化编辑器研发**:打造体验一流、多端支持的文档 & 表格编辑器
* **客户端开发**:探索移动端知识创作浏览的应有形态
* **服务端开发**:用 Node.js 打造多人实时协作的文档服务,利用 AI 技术挖掘优质内容、提高搜索质量


欢迎自荐/推荐: [[email protected]](mailto:[email protected])
95 changes: 95 additions & 0 deletions about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
# 语雀是什么?

> 写文档,就用语雀
## 缘起

__「语雀」__是一个__「知识创作工具」__,孵化自 [蚂蚁金服](https://www.antfin.com/) ,是 [体验科技](https://zhuanlan.zhihu.com/xtech) 理念下的一款创新产品,已是 5万+ 阿里员工进行文档编写、知识沉淀的标配。一开始,我们只是希望给工程师提供一个写技术文档的 Web 工具,达成__「文由汝心生、笔墨语雀来」__这个小目标____在打磨产品过程中,我们发现身边的每个人、每个团队、每个组织都有很多知识,但一直以来缺少一个好用的工具让这些知识不只是留在每个人的大脑或者电脑里,还可以被记录、分享和交流。带着这颗初心,我们觉得语雀不应止步于服务工程师,应该致力于为每个想表达所思所想的人提供一款顺手的工具,让知识能得以记录和传播,__让人们可以在「语雀」中平等快乐地创作和交流知识__

__<span data-type="color" style="color: rgb(208, 60, 60);">「语」</span>__字来源于「言语」,泛指人类沟通交流的方式,代表产品核心在于让人与人之间更有效地进行交流,承载交流过程中需要用到的文本、图画、表格等典型载体。

__<span data-type="color" style="color: rgb(208, 60, 60);">「雀」</span>__字来源于「云雀」,也即[《从百草园到三味书屋》](https://baike.baidu.com/item/%E4%BB%8E%E7%99%BE%E8%8D%89%E5%9B%AD%E5%88%B0%E4%B8%89%E5%91%B3%E4%B9%A6%E5%B1%8B/396387)中的叫天子,一种轻灵活泼的杭州本土小鸟,在诗人雪莱的杰作[《致云雀》](https://baike.baidu.com/item/%E8%87%B4%E4%BA%91%E9%9B%80/9451332)中象征“欢乐、光明、美丽”,代表产品风格为「轻灵美观」。

<span data-type="background" style="background-color: rgb(228, 247, 255);"><strong>语雀,一只能言善语的云雀,伴随大家在「知识的世界里」欢快翱翔。</strong></span>

## 愿景

> __语雀成为人们创作和交流知识的方式__
* __语雀伴君走江湖:__写文档,就用语雀,在任何公司、任何团队、任何设备,你都可以用语雀
* __多元化知识创造:__涵盖文本、图片、表格等典型知识载体,支持创作动态内容
* __清新美观的阅读体验:__给知识在不同设备、不同场景下设计最佳呈现

## 服务

语雀将会围绕__三种典型知识载体__提供核心服务:

* __文:__通过文字附以少量图片和表格来知识,是一种综合形态,人人皆可创作
* __图:__通过创作图并且对之进行排布和组织来表达知识,设计师、艺术家、架构师偏爱
* __表:__通过表格来呈现知识,项目管理、HR、销售、财务等人员最常用

__支持三种典型的知识形态:__

* __碎片化:__描述具体的知识点,通俗易懂
* __结构化:__看重知识的条理性和实用性,有一定专业背景才能看懂
* __体系化:__对某一领域的完整解读,通常是某类知识的专业或权威之作

__提供两种使用方式:__

* __公共空间:__为个人用户、小团队、社会组织、兴趣小组等提供免费服务,让再小的个体也能拥有自己的知识库
* __企业空间:__为企业提供 [付费服务](https://yuque.com/pricing)__(内测期间费用减免)__,独立域名,数据隔离,仅员工可访问,支持全文检索、Office 文件导入、Confluence 迁移,让每个企业轻松拥有知识库

__包含三大核心功能:__

* __知识库:__以文本、表格、画板为载体的结构化知识库,助力企业、团队、个人完成知识资产积累
* __讨论区:__让讨论不止于讨论,还有行动和沉淀
* __企业之家:__企业空间专享功能,让每个企业轻松拥有知识门户

> 公共空间和企业空间的基础功能是一致的,企业空间只会多出企业所需的一些特有功能。
> 目前只推出文档知识库,其它功能还在努力研发中,欢迎感兴趣者 [加入我们](https://yuque.com/yuque/jobs/join) 一起打造这些功能。
## 使用场景

### 个人用户

[新建知识库](https://yuque.com/new) 即可开始__个人创作和知识管理__

* 你可以编写自己的个人博客,比如 [红魔馆](https://yuque.com/xadillax/koumakan)
* 你也可以建一个私密仓库,存放个人笔记
* 你还可以用它来收集和整理资料,构建自己的知识库
* ...

### 小型组织

适用于一些小团队、社团、社会组织、学习小组,在语雀上 [创建一个团队](https://yuque.com/yuque/help/create_team) 即可__一群人一起创作可持续更新知识库__

* 编写团队博客
* 集体写书、翻译书籍
* 分工编写文档
* 制作帮助手册、产品说明、API 手册
* 收集整理感兴趣的知识
* 团队内异步交流
* ...

典型案例:

* [语雀](https://yuque.com/yuque)
* [Ruby China](https://yuque.com/ruby-china)
* [Eggjs](https://yuque.com/egg)

### 企业用户

适用于正规营运的企业和组织机构,在语雀上开通 [企业空间](https://yuque.com/yuque/help/what-is-enterprise-space) 就可以开始构建专属知识库,__沉淀企业知识资产__

* 项目文档编写
* 团队事务管理、知识沉淀
* 企业规章制度、流程
* 产品说明书
* 人事管理的流程
* ...

## 与语雀一起成长

> 书写精彩,从语雀开始...
虽然语雀的理想很远大,但现实很骨感,我们呈现给大家的只是一个刚好可用的文档工具,还有非常多的功能有待开发。__感谢大家愿意与语雀一起成长,共同开启全新知识创作之旅。__语雀会持续努力,为你奉上精心打磨、值得信赖的产品。如果你觉得语雀好用,请推荐给你的同事、朋友,非常感谢。
58 changes: 58 additions & 0 deletions bind_dingtalk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# 绑定钉钉登录

本文所描述的钉钉操作,只能由 __钉钉企业管理员 __进行。
完成此绑定后,在钉钉本企业通讯录中的所有员工可以直接用钉钉扫码登录语雀,无需注册。

整个过程需要两步操作。

## 第一步 : 创建企业内部 App

打开语雀企业后台管理,进入企业设置,在左边导航栏找到「钉钉登录」功能,注意下图的红框中logo地址和回调域名后面需要在钉钉开放平台中填写

![image.png | center | 832x454](https://lark-assets-prod.oss-cn-hangzhou.aliyuncs.com/2018/png/8ad28a29-7a92-4254-9b6a-7cd3218c079b.png "")

再到 [钉钉开放平台 - 自助工具](https://open-dev.dingtalk.com/#/loginAndShareApp) 页面,点击「创建扫码登录应用授权」按钮,进行应用创建。

![image.png | center | 832x268](https://lark-assets-prod.oss-cn-hangzhou.aliyuncs.com/2018/png/73c695f7-6f79-49d9-9c12-d0abbb27e1f6.png "")

将语雀提供「授权 LOGO 地址」和「回调域名」复制到下面的页面信息中, 并输入名称和描述,这里的名称和描述也可以复制语雀「绑定钉钉登陆」页面里面给你生成的名称和描述。

![image.png | center | 752x371](https://lark-assets-prod.oss-cn-hangzhou.aliyuncs.com/2018/png/3c1b22a1-3284-4a11-be23-2e341569bac6.png "")

点击「确定」后,会在应用列表中出现一条新的记录。

![image.png | center | 832x233](https://lark-assets-prod.oss-cn-hangzhou.aliyuncs.com/2018/png/78504601-9cc0-41d7-b832-a98bf118fc22.png "")

复制的 appId 和 appSecret 到语雀「绑定钉钉登陆」页面相对应的输入区。
![image.png | left | 471x367](https://lark-assets-prod.oss-cn-hangzhou.aliyuncs.com/2018/png/b2220028-01a9-444d-95e3-0b65efc8d5e3.png "")
## 第二步 : 生成新的企业内部 CorpSecret

[钉钉开放平台 - 开发账号管理](https://open-dev.dingtalk.com/#/corpAuthInfo) 页面,生成 Corpid 和 CorpSecret

如下图,Corpid 直接复制红框内的 Corpid 即可,CorpSecret 则需要先点击下图蓝框中按钮

![image.png | center | 832x532](https://lark-assets-prod.oss-cn-hangzhou.aliyuncs.com/2018/png/add5239a-fcf2-45ed-bd65-301ed9706e32.png "")

在「生成CorpSecret」弹出中输入相对应的名称,比如“企业知识库”,在关联部门中选择点击“通讯录”,选择整个企业。
在「__服务器公网出口 IP 白名单」__填写以下 IP 地址:

```plain
101.132.237.39
```

<span data-type="color" style="color:#FFA940;">注意:一定要填写这个IP,如果没有填写可能绑定以后无法访问。</span>

点击确认后,即可生成 CorpSecret 信息,可在新生成的列表中复制这个信息。

![Screen Shot 2018-01-13 at 3.40.08 PM.png | left | 614x453](https://lark-assets-prod.oss-cn-hangzhou.aliyuncs.com/2018/png/8072a47b-fa49-42e8-b48d-067d4900293f.png "")

然后打开 语雀 后台管理,进入企业设置,在左边导航栏找到「钉钉登录」
将 CorpId 和新生成的 CorpSecret,填写到语雀「绑定钉钉登陆」的相应页面信息里。
![image.png | left | 590x426](https://lark-assets-prod.oss-cn-hangzhou.aliyuncs.com/2018/png/29a1398a-8a8b-44a9-af68-41f7028dcfaa.png "")
## 扫码测试
绑定后,在此未登录下访问企业空间域名,会跳转到钉钉扫码登录,马上掏出手机测试下吧。下图是云工作室的案例:


![Screen Shot 2018-01-25 at 11.53.46 AM.png | center | 394x469](https://lark-assets-prod.oss-cn-hangzhou.aliyuncs.com/2018/png/3e82e1c9-d71d-498d-bba1-7c551b074f94.png "")


15 changes: 15 additions & 0 deletions cd5825.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# 如何转移知识库

在语雀中知识库可以在不同团队或者个人下进行移动。只需要进入“知识库设置”-“高级设置”,选择“转移知识库功能”即可。注意,转移功能只有 Owner 拥有。


![Screen Shot 2018-01-01 at 11.43.31 AM.png | center | 832x313](https://lark-assets-prod.oss-cn-hangzhou.aliyuncs.com/2018/png/812744f2-9a01-41b6-9097-84fad7034dac.png "")


选择一个你目标团队或者个人,点击转移按钮,系统会进行二次确认。确认通过后知识库会直接转移到你的目标团队或者个人中。


![Screen Shot 2018-01-01 at 11.44.51 AM.png | center | 832x552](https://lark-assets-prod.oss-cn-hangzhou.aliyuncs.com/2018/png/e9dfe195-743f-4641-a7ee-cf9115f3dc8f.png "")



9 changes: 9 additions & 0 deletions cg9hye.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# 支持那些快捷键?

在文档编辑器的「帮助」- 「快捷键」找到所有的快捷键列表。

![image.png | center | 653x309](https://lark-assets-prod.oss-cn-hangzhou.aliyuncs.com/2018/png/eab43026-b130-4769-a9db-1692f1b906c1.png "")

![image.png | center | 739x499](https://lark-assets-prod.oss-cn-hangzhou.aliyuncs.com/2018/png/4f0dcee2-0e04-49f2-816c-33a363ca1387.png "")


7 changes: 7 additions & 0 deletions contact.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# 联系我们

一般的使用问题,你可以在我们的帮助文档找到答案。

如果遇到疑难问题和使用故障,您可以通过邮箱 [[email protected]](mailto:[email protected]) 联系我们


17 changes: 17 additions & 0 deletions cooperate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# 多人协作

语雀的知识库本质上是对团队开放编辑能力的,团队成员可以编辑团队知识库下的任何文档。为了保证文档编辑的体验,每篇文档同时只允许一位成员进行编辑。而在文档编写的过程中,难免出现一些场景需要多位团队成员一起完成一份文档的需求。

语雀通过『协作区域』来实现多人协作编写文档。顾名思义,『协作区域』是一个可以邀请其他团队成员来帮助你一起完成一篇文档的功能,使用协作区域,我们可以和团队成员一起协作,在互不打扰下同时编写文档。

通过工具栏中的协作按钮,可以快速在文档中插入一个协作区域,将内容交由团队成员来编辑,协作者会收到一条协作通知(站内消息和邮件)。

![Kapture 2018-02-01 at 10.51.25.gif | center | 640x366](https://gw.alipayobjects.com/zos/skylark/c8d5a6e4-f685-4171-aabe-058ceb03ca7f/2018/gif/27aaf5e2-10d4-4d2a-b22c-cc61b5526a6f.gif "")

在编辑文档时,多个协作区域或文章主体(协作区域之外的所有内容)可以被不同的团队成员同时编辑,某个协作区域被编辑时,此区域将被锁定,其他成员不能同时编辑,避免冲突。
你可以实时看到其他区域的编辑状态,为了防止其他区域的编辑会影响你的写作,我们将其他区域的内容更新交给写作者手动操作,你可以根据需要,手动更新别人编辑过的区域内容。





17 changes: 17 additions & 0 deletions cpeo0y.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# 如何设置目录

“目录”页面展示知识库内部的文档。

如果你不编辑该页面,那么目录页将会自动生成,按照发布时间的倒序,列出当前知识库的所有已发布文档。

如果你需要定制目录页(比如建立目录结构),那么需要点击右上角的“编辑目录”按钮。

![964fa33c-da65-40e4-a633-5d99779e0fbd.png | left | 92x92](https://lark-assets-prod.oss-cn-hangzhou.aliyuncs.com/2017/png/460f1655-a51c-4f62-acac-a20fcc4b8c48.png "")

目标编辑页分为左右两个部分。左侧是还未加入目录的文档,可以点击加入右侧光标处。右侧是目录编辑框,新建目录项只要按一下回车键,删除目录项就是把该行目录全删除,按 Tab 键就可以让目录项缩进一个级别。“设为目录节点”则是让该节点成为一个单纯目录项,没有对应的文档页。

![956a4c82-7ebd-4a73-a5a3-9fa09e4464f1.png | left | 508x347](https://lark-assets-prod.oss-cn-hangzhou.aliyuncs.com/2017/png/99be2dec-8ea7-4e5b-972e-3beffc80677c.png "")

注意:一旦定制了目录,目录就不再会自动更新。任何变化都必须手动更新目录,才会在目录页上反映出来。

另外,语雀的目录不仅可以包含当前知识库的文档,还可以外链到其他知识库和互联网上的内容。
17 changes: 17 additions & 0 deletions create_team.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# 如何新建团队?

首先在导航条上,选择 “+” 进行新建功能,选择新建团队。


![Screen Shot 2018-01-01 at 11.09.41 AM.png | left | 450x199](https://lark-assets-prod.oss-cn-hangzhou.aliyuncs.com/2018/png/1ff4efab-0dcc-4e30-a74c-341ed4bf0e99.png "")

填入以下信息,点击新建按钮即可完成团队新建。


![Screen Shot 2018-01-01 at 11.11.06 AM.png | center | 832x565](https://lark-assets-prod.oss-cn-hangzhou.aliyuncs.com/2018/png/f7175e88-6509-4a75-980c-f2ddfaa43692.png "")

注意:路径开放定制,你可以选择适合你团队的路径,比如

`https://yuque.com/`<span style="color:#D03C3C;">`helloword`</span>` `

helloword就是你对你的团队单独定制的个性后缀。
Loading

0 comments on commit 96af48d

Please sign in to comment.