Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrcfps/gwp
Go Web Programming
https://github.com/mrcfps/gwp
Last synced: 19 days ago
JSON representation
Go Web Programming
- Host: GitHub
- URL: https://github.com/mrcfps/gwp
- Owner: mrcfps
- Created: 2018-05-10T13:01:48.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-07-30T05:33:00.000Z (over 6 years ago)
- Last Synced: 2024-11-05T15:50:38.362Z (2 months ago)
- Language: Go
- Size: 442 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Tuture
[](https://travis-ci.com/tutureproject/tuture/)
Tuture is a tool for writing high-quality tutorials with both ease and speed based on Git repositories.
_Read this in other languages_: [简体中文](README.zh-CN.md).
## Features
Tuture revolutionizes the way of writing tech tutorials.
- **Generated directly from a live codebase**: Your tutorial will be a faithful mirror of your code. Just start from a Git repo, build something interesting with nicely-written commit messages, and Tuture will bring all the good things to your tutorial. Your codebase will grow as more inspiration come in, so will your tutorial.
- **Automatic extraction of code diff**: One of the greatest pain point of writing tutorials is the daunting manual work of collecting code snippets of each changed file for each step. Fortunately, Tuture will handle this boring and error-prone work for you, so you can just focus on writing amazing tuturials.
- **Writing in a programming way**: Writing is more of a casual and personal course in these good old days. But with Tuture, you can write tutorial in a way that greatly resembles programming. Your whole tutorial is exactly specified in a YAML file, so all you need is to fill in needed fields.
- **Eye-catching rendering in the browser**: Thanks to the blazingly fast development of JavaScript technologies, Tuture is fully capable of rendering your tutorial in a beautiful and interactive way.
## Installation
Make sure you have [Node.js](https://nodejs.org/) (>= 8.0.0) and [npm](https://www.npmjs.com/) (>= 5.0.0) on your machine.
> You may need `sudo` to install npm packages globally.
- **install with npm**
```bash
$ npm i -g tuture tuture-cli
```
- **install with yarn**
```bash
$ yarn global add tuture tuture-cli
```
> Installing global binaries via yarn can fail sometimes (check out this [issue](https://github.com/yarnpkg/yarn/issues/1321)), so it's not recommended. But you can `export PATH="$PATH:$(yarn global bin)"` if you insist.
- **install from source**
Clone this repo and [tuture-cli](https://github.com/tutureproject/cli) to your machine, and `cd` into these repos and run following command respectively:
```bash
$ npm i -g
```
## Documentation
- [CLI Commands](docs/CLI_COMMANDS.md) is a detailed manual on using Tuture CLI.
- [tuture.yml Specification](docs/TUTURE_YML_SPEC.md) is a complete specification of **tuture.yml**.
## How to write a Tuture tutorial
Writing a Tuture tutorial is incredibly simple and delightful.
1. Initialize a Git repo (or start from an existing one)
2. Write some code and commit with a meaningful message
3. Run `tuture init` to initialize a Tuture tutorial
4. Write some instructions in related `explain` fields in **tuture.yml**
5. Run `tuture up` to see your tutorial live in the browser
6. Edit **tuture.yml** and save to change something
## Why this name, Tuture?
Tutorials from the future.
## License
Definitely [MIT](LICENSE).