tuture
Version:
Write tutorials from the future, with the power of Git and community.
115 lines (71 loc) • 10.2 kB
Markdown
<p align="center"><img style="width: 200px" src="https://user-gold-cdn.xitu.io/2020/4/8/171577bb979987bd?w=330&h=400&f=svg&s=3342"/></p>
<p align="center" style="font-size: 24px;">Git + Tuture = Tutorial（教程）</p>
<p align="center" style="font-size: 16px;">” 基于 Git，为写作技术实战教程而生 “</p>
<p align="center" style="font-size: 16px;"> <a href="https://www.yuque.com/tuture/product-manuals/nsaphr">你可能想了解我们为什么要创建图雀社区？</a> </p>
<p align="center" style="font-size: 16px;"> <a href="https://www.yuque.com/tuture/product-manuals/ckx8ry">以及关于图雀社区的常见问题解答</a> </p>
## 介绍
Tuture 是一款基于 Git 版本控制系统、为实战技术教程创作而生的写作工具，具备以下核心优势：
- 根据提交记录自动生成教程骨架，无需手动整理代码
- 对着代码“讲故事”，思路更清晰，写作更愉快
- 专业美观的写作界面，提供全方位的支持，让你专注于内容创作
- 内容的同步和协作基于 Git 分布式版本控制系统，为社区创作开启无限可能
- 强大且方便的内容导出和发布，帮助你的文章快速传播，得到更多读者的认可
### 免责声明（郑重提醒）
Tuture 为教程内容创作而生，因此 Git 仓库通常是**专门用于教学演示的示例项目**。我们无法担保把 Linux 内核仓库（98 万多次提交）转换成 Tuture 教程的效果哦！
## 生态
| **项目** | **状态** | **描述** |
| :----------------------------------------------: | :------: | :---------------------------------------: |
| [Tuture](https://github.com/tuture-dev/tuture) | 活跃 | 基于 Git 快速撰写技术教程 |
| [Editure](https://github.com/tuture-dev/editure) | 活跃 | 基于 Slate 的 Markdown 富文本一体的编辑器 |
| [图雀社区](https://github.com/tuture-dev/hub) | 活跃 | 发布使用 Tuture 写作而成的技术教程 |
<a name="PUOxn"></a>
## 如何快速使用？
在一个已有提交的 Git 项目根目录下运行如下命令：
1. 安装 Tuture 写作工具
```bash
npm install -g tuture
```
2. 克隆我们为你准备的代码：
```bash
git clone https://github.com/tuture-dev/our-tuture.git
```
3. 进入项目根目录并使用 `tuture` 运行命令：
```bash
cd our-tuture && tuture up
```
这个时候你应该可以看到如下的界面：
## 快速开始
如果你想自己从零开始体会如何基于一个 Git 项目撰写实战技术教程，那么我们我们为你撰写了一篇 [”场景化“ 的快速上手教程](https://www.yuque.com/tuture/product-manuals)，无论你对 Git 有没有了解，你都能很好的学会使用 Tuture 写作工具。
## 文档
如果你想更多的了解 Tuture，可以阅读我们的如下文档：
- [简介和优势](https://www.yuque.com/tuture/product-manuals/overview)
- [关键概念](https://www.yuque.com/tuture/product-manuals/concepts)
- [更多文档...](https://www.yuque.com/tuture/product-manuals)
## 作品
| 名称 | 封面 | 仓库地址 |
| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 从零到部署：用 Vue 和 Express 实现迷你全栈电商应用（系列） | <img width="200" src="https://tva1.sinaimg.cn/large/00831rSTgy1gdmdz6q1hjj309g048t9r.jpg"/> | - [仓库地址](https://github.com/tuture-dev/vue-online-shop-frontend)<br />- [图雀社区](https://tuture.co/2019/10/17/0b662ce/)<br />- [微信公众号](https://mp.weixin.qq.com/s/1YdC9mY3JTqxSuJ9G4l1Qw)<br /> |
| Taro 小程序开发大型实战（系列） | <img width="200" src="https://tva1.sinaimg.cn/large/00831rSTgy1gdme080rr4j30ao04mmyg.jpg"/> | - [仓库地址](https://github.com/tuture-dev/ultra-club)<br />- [图雀社区](https://tuture.co/2019/12/26/34a473b/)<br />- [微信公众号](https://mp.weixin.qq.com/s/KtnhfEx-cq1V-TDV67V-Qg) <br /> |
| Docker 筑梦师系列 | <img width="200" src="https://tva1.sinaimg.cn/large/00831rSTgy1gdme151sflj30as04uta5.jpg"/> | - [仓库地址](https://github.com/tuture-dev/docker-dream)<br />- [图雀社区](https://tuture.co/2020/01/01/442cc8d/)<br />- [微信公众号](https://mp.weixin.qq.com/s/GmkMFd0frqBNZN0u4sy8Ow)<br /> |
| 类型即定义：TypeScript 从入门到实践系列 | <img width="200" src="https://tva1.sinaimg.cn/large/00831rSTgy1gdme83j3apj30aq04qabx.jpg"/> | - [仓库地址](https://github.com/tuture-dev/typescript-tea)<br />- [图雀社区](https://tuture.co/2020/04/06/C_ao1Yv/) <br />- [微信公众号](https://mp.weixin.qq.com/s/u230EnsNh-WMSC07FSi2wg)<br /> |
<p align="center"><a href="https://tuture.co/">查看更多 （30+篇）使用 Tuture 写作工具写作的教程 →</a></p>
## 作者
感谢所有图雀社区的作者名，写出了这些精彩的技术文章，让我们的技术世界更加美好！✌️
|  |  |  |  |  |
| :------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------: |
| [mRcfps](https://github.com/mRcfps) | [pftom](https://github.com/pftom) | [HolyHeart](https://github.com/HolyHeart) | [crxk](https://github.com/crxk) | [晨曦时梦见兮](https://juejin.im/user/5b13f11d5188257da1245183) |
|  |  |  |  |  |
| [慢一拍](https://mp.weixin.qq.com/mp/profile_ext?action=home&__biz=MzIzNjYyNjMxNg==&scene=124#wechat_redirect) | [JowayYoung](https://juejin.im/user/584ec3a661ff4b006cd6383e) | [布拉德特皮](https://github.com/SephirothKid) | [Horace\_](http://ihorace.cn/) | [婧婧](https://jinghao.xyz/) |
## 提问、联系或加入我们
如果你对 Tuture 写作工具有任何疑问、改进意见，都可以关注我们的公众号进图雀社区官方反馈学习交流群：
## 贡献
请确保你在提交 Pull Request 之前先阅读了 [贡献指南](https://www.yuque.com/tuture/mtnpg1/xxxx) ！感谢所有已经给 Tuture 提交贡献的人！
| <img style="width: 200px;" src="https://tva1.sinaimg.cn/large/00831rSTgy1gdm6rv9wx5j308o08odhc.jpg" /> | <img style="width: 200px;" src="https://tva1.sinaimg.cn/large/00831rSTgy1gdm6scg251j308o08oq58.jpg"/> | <img style="width: 200px;" src="https://tva1.sinaimg.cn/large/00831rSTgy1gdm6soy5jhj308o08omyb.jpg"/> | <img style="width: 200px" src="https://tva1.sinaimg.cn/large/00831rSTgy1gdm6tje8qtj308o08o781.jpg" /> |
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| [mRcfps](https://github.com/mRcfps)<br />Tuture & Editure <br />Tuture 共同创始人 | [pftom](https://github.com/pftom)<br />Tuture & Editure<br />Tuture 共同创始人 | [studytoohard](https://github.com/studytoohard)<br />Tuture<br />Tuture 核心贡献者 | [HolyHeart](https://github.com/HolyHeart)<br />Tuture<br />Tuture 核心贡献者 |
## 协议
[MIT](https://github.com/tuture-dev/tuture/blob/master/LICENSE)
Copyright (c) 2018-present, Tuture Devlopers