tuture
Tuture magically turns your repositories into juicy tutorials.
Last updated 2 months ago by powerformarc .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install tuture -g
SYNC missed versions from official npm registry.

Git + Tuture = Tutorial(教程),专为实战教程创作而生

” 教程文档界的 Github “




编组 2

介绍


Tuture 是一个基于 Git 的实战技术教程写作工具,它可以让你以先做一个项目,然后对照刚刚做的项目的每次代码提交进行讲解的方式来撰写实战技术教程,这样写教程的过程中不再是先组织概念,而是变为先做一个项目,程序员擅长做项目解决问题,而 Tuture 正是顺应了程序员的这一点偏好,专注于辅助你写好项目代码的注解,解放你的技术实战教程写作过程,为实战技术教程创作 ”提效“。

生态

项目 状态 描述
Tuture 活跃 基于 Git 快速撰写技术教程
Editure 活跃 基于 Slate 的 Markdown 富文本一体的编辑器
图雀社区 活跃 发布使用 Tuture 写作而成的技术教程

如何快速使用?


在一个已有提交的 Git 项目根目录下运行如下命令:

1)安装 npm install -g tuture
2)克隆我们为你准备的代码: git clone git@github.com:tuture-dev/our-tuture.git
3) 进入项目根目录并使用 tuture 运行命令: cd our-tuture && tuture up

注意:这里的已有提交的 Git 项目只专为创作教程而生的项目,而不是那些动辄好几十上百个 Commits 的大型开发项目。



这个时候你应该可以看到如下的界面:

00831rSTgy1gdm5loil8pj31580u0tib


免责声明(郑重提醒)


Tuture 为教程内容创作而生,因此 Git 仓库通常是专门用于教学演示的示例项目。我们无法担保把 Linux 内核仓库(98 万多次提交)转换成 Tuture 教程的效果哦!

快速开始


如果你想自己从零开始体会如何基于一个 Git 项目撰写实战技术教程,那么我们我们为你撰写了一篇 ”场景化“ 的快速上手教程,无论你对 Git 有没有了解,你都能很好的学会使用 Tuture 写作工具。

文档


如果你想更多的了解 Tuture,可以阅读我们的如下文档:

作品

名称 封面 仓库地址
从零到部署:用 Vue 和 Express 实现迷你全栈电商应用(系列) - 仓库地址
- 图雀社区
- 微信公众号
Taro 小程序开发大型实战(系列) - 仓库地址
- 图雀社区
- 微信公众号
Docker 筑梦师系列 - 仓库地址
- 图雀社区
- 微信公众号
类型即定义:TypeScript 从入门到实践系列 - 仓库地址
- 图雀社区
- 微信公众号

查看更多 (30+篇)使用 Tuture 写作工具写作的教程 →


作者


感谢所有图雀社区的作者名,写出了这些精彩的技术文章,让我们的技术世界更加美好!✌️

4.svg 3.svg 2.svg 1.svg 6.svg
mRcfps pftom HolyHeart crxk 晨曦时梦见兮
8.svg 7.svg 10.svg 9.svg 5.svg
慢一拍 JowayYoung 布拉德特皮 Horace_ 婧婧

提问、联系或加入我们


如果你对 Tuture 写作工具有任何疑问、改进意见,都可以关注我们的公众号进图雀社区官方反馈学习交流群:

微信公众号(真).png

贡献


请确保你在提交 Pull Request 之前先阅读了 贡献指南

感谢所有已经给 Tuture 提交贡献的人!

mRcfps
Tuture & Editure
Tuture 共同创始人
pftom
Tuture & Editure
Tuture 共同创始人
studytoohard
Tuture
Tuture 核心贡献者
HolyHeart
Tuture
Tuture 核心贡献者

协议


MIT

Copyright (c) 2018-present, Tuture Devlopers

Current Tags

  • 3.0.0-alpha9                                ...           latest (2 months ago)

33 Versions

  • 3.0.0-alpha9                                ...           2 months ago
  • 3.0.0-alpha8                                ...           2 months ago
  • 3.0.0-alpha7                                ...           2 months ago
  • 3.0.0-alpha6                                ...           2 months ago
  • 3.0.0-alpha5                                ...           3 months ago
  • 3.0.0-alpha4                                ...           3 months ago
  • 3.0.0-alpha3                                ...           3 months ago
  • 3.0.0-alpha2                                ...           3 months ago
  • 3.0.0-alpha1                                ...           3 months ago
  • 3.0.0-alpha0                                ...           3 months ago
  • 2.1.0                                ...           5 months ago
  • 2.0.1                                ...           6 months ago
  • 1.6.2                                ...           7 months ago
  • 1.6.1                                ...           7 months ago
  • 1.6.0                                ...           7 months ago
  • 1.5.0                                ...           2 years ago
  • 1.4.0                                ...           2 years ago
  • 1.3.2                                ...           2 years ago
  • 1.3.1                                ...           2 years ago
  • 1.3.0                                ...           2 years ago
  • 1.2.1                                ...           2 years ago
  • 1.2.0                                ...           2 years ago
  • 1.1.0                                ...           2 years ago
  • 1.0.1                                ...           2 years ago
  • 0.3.1                                ...           2 years ago
  • 0.3.0                                ...           2 years ago
  • 0.2.4                                ...           2 years ago
  • 0.2.3                                ...           2 years ago
  • 0.2.2                                ...           2 years ago
  • 0.2.1                                ...           2 years ago
  • 0.2.0                                ...           2 years ago
  • 0.1.0                                ...           2 years ago
  • 1.0.0                                ...           2 years ago
Downloads
Today 0
This Week 2
This Month 7
Last Day 0
Last Week 1
Last Month 101
Dependencies (23)
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |