Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

tuture

tuture-dev101MIT3.0.0-alpha10TypeScript support: included

Write tutorials from the future, with the power of Git and community.

learn-by-doing, learn-by-examples, hands-on, tutorial, diff-viewer, git

readme

Git + Tuture = Tutorial(教程)

” 基于 Git,为写作技术实战教程而生 “

你可能想了解我们为什么要创建图雀社区?

以及关于图雀社区的常见问题解答

编组 2

介绍

Tuture 是一款基于 Git 版本控制系统、为实战技术教程创作而生的写作工具,具备以下核心优势:

  • 根据提交记录自动生成教程骨架,无需手动整理代码
  • 对着代码“讲故事”,思路更清晰,写作更愉快
  • 专业美观的写作界面,提供全方位的支持,让你专注于内容创作
  • 内容的同步和协作基于 Git 分布式版本控制系统,为社区创作开启无限可能
  • 强大且方便的内容导出和发布,帮助你的文章快速传播,得到更多读者的认可

免责声明(郑重提醒)

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

生态

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

如何快速使用?

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

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

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

00831rSTgy1gdm5loil8pj31580u0tib

快速开始

如果你想自己从零开始体会如何基于一个 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 写作工具有任何疑问、改进意见,都可以关注我们的公众号进图雀社区官方反馈学习交流群:

贡献

请确保你在提交 Pull Request 之前先阅读了 贡献指南 !感谢所有已经给 Tuture 提交贡献的人!

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

协议

MIT

Copyright (c) 2018-present, Tuture Devlopers

changelog

Changelog

2.1.0

What's New

  • Brand new markdown editor for better writing experience
  • Auto-save your tutorial while writing
  • Note blocks (info, warning, etc.) are fully supported

Improvements

  • Automatically infer github field for init command
  • Ensure order of created timestamps for multiple splits
  • Improve codeblock compatibility for building plain markdown

Bug Fixes

  • Fix metadata for splits
  • Fix linebreak for code blocks in editor

2.0.1

  • Fix almost all bugs around image uploading in editor
  • Fix annoying "No newline at end of file" in code diff
  • Add categories to tuture.yml spec
  • Ignore build output directory when initializing

2.0.0 (unpublished)

What's New

  • Add support for hexo post building
  • Add support for splitting tutorials
  • Add fully-fledged configuration system (via .tuturerc and .tutureignore)
  • Enable serving assets/images with GitHub
  • Remove login and publish command
  • Delicately adjusted editor UI

Bug Fixes

  • Fix editor display when there are no commits
  • Fix image upload in editor
  • Fix undesired generation of tuture-error.log

1.4.0

New Features

  • Add i18n (internationalization) support

1.3.1

Improvements

  • Add hint for adding tutorial description
  • Open new browser window for links

Bug Fixes

  • Fix crashing problem when no topics given

1.3.0

New Features

= description and topics for each tutorial are added

  • You can now edit titles of the tutorial and each step

Improvements

  • Save tutorial right after finishing a single explanation area
  • Size of images is now carefully adjusted
  • Enable syntax highlighting for code blocks within markdown
  • Copying code will now only include added lines

Bug Fixes

  • Fix content sidebar clicking and scrolling issue
  • Fix incorrect line number of code blocks
  • Fix browser not open issue when calling tuture-server
  • Ignore outdated steps by default

1.2.1

Bug Fixes

Fix bug of Save/Edit button not working.

1.2.0

New Features

  • Add right sidebar for managing changed files within a step easily
  • Updated UI with delicate responsive design

Improvements

  • Personalized placeholder for "Add Explain" buttons
  • Cute icons for markdown editor toolbar
  • Add tooltip after "Adding to Clipboard"
  • Add favicon

1.1.0

New Features

  • Add toolbar for markdown editor
  • Add copy-to-clipboard function for each code block

Improvements

tuture-server now fully supports dynamic port usage.

1.0.1

Bump version due to a historical mistake.

1.0.0

New Features

Edit your tutorial just in browser!

  • Smooth transition between edit and preview mode
  • Full-fledged markdown support (Yes! We support image uploading)
  • Move all steps into one page

Improvements

  • Ridiculously fast launch speed, due to our new SSR (Server-Side Rendering) architecture
  • Syntax highlighting support for nearly all languages

0.3.1

Rename the global binary to tuture-server.

0.3.0

This package has been renamed to tuture.

0.2.1

New Features

  • Add line number for code blocks

Improvements

  • Disable code emphasis when the entire diff file is newly added

Bug Fixes

  • Fix broken syntax highlight in some cases

0.2.0

New Features

  • Brand-new UI
  • Add markdown support for writing explanations
  • Add syntax highlighting (currently only HTML, CSS, JavaScript) for code blocks
  • Reuse the same window when firing renderer for multiple times

Breaking Changes

  • Split view of diff is removed

Bug Fixes

  • Fix a bug where the page title would always be the default