tuture-dev / tuture Goto Github PK

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

如何快速使用？

在终端运行如下命令：

安装 Tuture 写作工具

npm install -g @tuture/cli

进入一个 Git 仓库并进行初始化（如果你手头没有的话，可以克隆我们提供的演示项目）：

cd /path/to/repo && tuture init

# 或者使用我们的演示项目（无需初始化）
git clone https://github.com/tuture-dev/our-tuture.git
cd our-tuture

打开编辑器进行写作：

tuture up

这个时候你应该可以看到类似下面的界面：

场景化的快速上手教程

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

文档

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

作品

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

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

## 作者

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


mRcfps	pftom	HolyHeart	crxk	晨曦时梦见兮

慢一拍	JowayYoung	布拉德特皮	Horace_	婧婧

提问、联系或加入我们

如果你对 Tuture 写作工具有任何疑问、改进意见，可以关注我们公众号（回复“交流”后加客服），或者加入 QQ / 钉钉群：

也可以发送邮件至我们的邮箱：[email protected]。

贡献

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


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

协议

MIT

tuture's People

Contributors

Stargazers

Watchers

Forkers

pftom mrcfps tomwenthey zrbjava hhy5277 steadyhua yaodebian oyeah-hua caojikeai banben hahanwusheng 1030693123 wwwk

tuture's Issues

Project catalogue structure display

New init project upload images cannot auto create tuture-assets folder

Use `TypeScript` rewrite this project

Use self-webpack config rewrite renderer

We need optimize following content:

Speed up server setup
Delete redundant dependencies
Use ENV_PATH rather than write a path.json file

Add error handle for js-yaml parser process.

Add syntax highlighting when renderering code

Currently code diff are renderered as plain text.

Fix code highlight problem.

Now, some diff code block will not display as normally!

Such as example's webpack.config.js.

tuture-error.log is generated even no error happened

gradually turn to `server side`

windows下编辑教程时上传图片 tuture工具把路径用反斜杠拼的

Optimize webpack compile speed as it's too slow

Code highlight config (design and dev)

Use copy-webpack-plugin copy all user project for display images assets

Display errors around code diff

There are currently two obvious problems on displaying code diff:

incorrect line numbers
missing hint for omitted lines of code

Below are screenshots on my newly written tutorial:

Real code:

Code diff in editor:

Note the missing code between Line 10 and Line 18 in the real code.

Editor need handle commit outdated circumstances.

Concentrate add markdown all elements style

Cancel spellcheck in codeblock

Markdown editor initializes with string "undefined"

Describe the bug
When adding new steps, initialize the markdown editor on empty explain blocks and see the string "undefined".

To Reproduce
Steps to reproduce the behavior:

Add a new step
Click on "Add explanation of this step"
The string "undefined" shows up in markdown editor

Expected behavior
There should be no "undefined" string.

Screenshots

Extract renderer as global npm: `tuture-renderer`

Tuture init topics/categories with Chinese are Lost

Describe the bug
When I use tuture init in a new project, then prompt Tutorial Name, Description, Topics, Categories, The Topics & Categories can add multiply split with ,, but When I add Chinese words, the final tuture.yml result not showing this Chinese word.

To Reproduce
Steps to reproduce the behavior:

Project folder
Run tuture init
Response Topics/Categories with Chinese words
Final tuture.yml not showing this Chinese words

Expected behavior
Topics/Categories can add Chinese words as well.

Screenshots

Desktop (please complete the following information):

OS: MacOS
Browser: Chrome
Node: v10.16.0
Npm: 6.9.0
tuture: tuture/2.0.1 darwin-x64 node-v10.16.0

Implement test suite

I'd like to implement with three stages:

Easily use jest snapshot test for component-level test
Use jest test other functionality-file
Use enzyme test for dom-level test

Make content align center

Build crash when empty file is present

When some files are empty, trying to build the tutorial will crash:

TypeError: Cannot read property 'changes' of undefined
    at codeBlock (~/OpenSource/tutureproject/tuture/build/commands/build.js:13:33)
    at diffTmpl (~/OpenSource/tutureproject/tuture/build/commands/build.js:24:3)
    at lodash_zip_1.default.map (~/OpenSource/tutureproject/tuture/build/commands/build.js:34:43)
    at Array.map (<anonymous>)
    at stepTmpl (~/OpenSource/tutureproject/tuture/build/commands/build.js:32:6)
    at lodash_zip_1.default.map (~/OpenSource/tutureproject/tuture/build/commands/build.js:45:30)
    at Array.map (<anonymous>)
    at tutorialTmpl (~/OpenSource/tutureproject/tuture/build/commands/build.js:43:6)
    at Build.run (~/OpenSource/tutureproject/tuture/build/commands/build.js:61:26)
    at Build._run (~/OpenSource/tutureproject/tuture/node_modules/@oclif/command/lib/command.js:29:31)

Unexpected tuture-assets directory

Even if you run init(or any help commands) in a brand new repository, it will create empty tuture-assets directory.

Test bug

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

Go to '...'
Click on '....'
Scroll down to '....'
See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

OS: [e.g. iOS]
Browser [e.g. chrome, safari]
Version [e.g. 22]

Smartphone (please complete the following information):

Device: [e.g. iPhone6]
OS: [e.g. iOS8.1]
Browser [e.g. stock browser, safari]
Version [e.g. 22]

Additional context
Add any other context about the problem here.

Fail to replace image links when building tutorials

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

Clone the ultra-club tutorial repository
Run tuture reload and tuture build
Some image links are not replaced with image hosting urls

Expected behavior
All image links should be replaced with image hosting urls.

Screenshots
Example output of one piece of tutorial:

Desktop (please complete the following information):

OS: [e.g. iOS]
Browser [e.g. chrome, safari]
Version [e.g. 22]

Smartphone (please complete the following information):

Device: [e.g. iPhone6]
OS: [e.g. iOS8.1]
Browser [e.g. stock browser, safari]
Version [e.g. 22]

Additional context
Add any other context about the problem here.

Delete redundant code.

Some remaining code need to be clean as they are not needed.

Make catalogue sticky to page

Editor display empty line's line break error

Add markdown support for writing explanations

Use `vanilla js` rewrite `diff-view`

Liberate from `antd` keep code clean

Build crash when both output destination and splits are specified

Describe the bug
When running tuture build -o foobar with multiple parts (i.e. splits is given), it crashes.

To Reproduce
Steps to reproduce the behavior:

Specifiy splits in tuture.yml as usual
Run tuture build -o foobar
See error

Expected behavior
Two choices (I don't know which one is better):

Create a directory with the named specified in -o or --output, and put all targets into it
Raise an error and tell the user

Screenshots

$ tuture build -o build
Error: Source and destination must not be the same.
    at checkPaths (~/OpenSource/tutureproject/tuture/node_modules/fs-extra/lib/copy-sync/copy-sync.js:185:11)
    at Object.copySync (~/OpenSource/tutureproject/tuture/node_modules/fs-extra/lib/copy-sync/copy-sync.js:25:20)
    at ~/OpenSource/tutureproject/tuture/build/commands/build.js:206:36
    at Array.forEach (<anonymous>)
    at Build.saveTutorials (~/OpenSource/tutureproject/tuture/build/commands/build.js:197:19)
    at Build.run (~/OpenSource/tutureproject/tuture/build/commands/build.js:231:14)
    at Build._run (~/OpenSource/tutureproject/tuture/node_modules/@oclif/command/lib/command.js:44:31)

Fix `webpack` path problem

pull command does not update assets table

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

Go to '...'
Click on '....'
Scroll down to '....'
See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

OS: [e.g. iOS]
Browser [e.g. chrome, safari]
Version [e.g. 22]

Smartphone (please complete the following information):

Device: [e.g. iPhone6]
OS: [e.g. iOS8.1]
Browser [e.g. stock browser, safari]
Version [e.g. 22]

Additional context
Add any other context about the problem here.

git clone https://github.com/hu-qi/huqi-awesome-tutorial
cd huqi-awesome-tutorial/
tuture init
tuture up

Expected behavior
期望能正常打开网页进行文章编写。

Screenshots

Desktop (please complete the following information):

OS: Microsoft Windows [版本 10.0.17763.1098]
Browser: Google Chrome 80.0.3987.122（正式版本）（64 位）
Version: null

Smartphone (please complete the following information):

Device: null
OS: null
Browser: null
Version: null

Additional context
初始化之后文件夹目录：

初始化之后配置文件：

( 奇怪的是github地址中用户名那少了一个"-")

In codeblock, copy and paste content will lost lineBreak

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

Go to '...'
Click on '....'
Scroll down to '....'
See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

OS: [e.g. iOS]
Browser [e.g. chrome, safari]
Version [e.g. 22]

Smartphone (please complete the following information):

Device: [e.g. iPhone6]
OS: [e.g. iOS8.1]
Browser [e.g. stock browser, safari]
Version [e.g. 22]

Additional context
Add any other context about the problem here.

Update tuture object to latest tuture.yml spec

The latest spec.

Example:

name: Name of this tutorial
language: en-US
version: 0.0.1
topics:
  - Topic A
  - Topic B
description: This is my first tutorial, come and read it!
maintainer: [email protected]
steps:
  - name: Message of commit ae05546
    commit: ae05546
    explain:
      pre: Introduction placed at the top of this step
      post: Sumup placed at the bottom of this step
    diff:
      - file: Changed file A
        section:
          start: 1
          end: 10
        explain: Introduction before doing something to this part of A
      - file: Changed file A
        section:
          start: 11
          end: 20
        explain: Introduction before doing something to this part of A
      - file: Changed file B
        explain:
          pre: Introduction before doing something to B
          post: Explanation after doing something to B
  - name: Message of commit ae05546
    commit: a45bec1
    explain:
      pre: Introduction placed at the top of this step
      post: Sumup placed at the bottom of this step
    diff:
      - file: Changed file A
        explain:
          pre: Introduction before doing something to A
          post: Explanation after doing something to A
      - file: Changed file B
        explain: Introduction before doing something to B
      - file: Changed file C
        explain:
          pre: Introduction before doing something to C
          post: Explanation after doing something to C