tutorials
所属分类:文章/文档
开发工具:HTML
文件大小:4416KB
下载次数:0
上传日期:2022-01-15 19:29:55
上 传 者:
sh-1993
说明: 我的编程课程教程
(Tutorials for my programming courses)
文件列表:
.nojekyll (2, 2022-01-16)
docs (0, 2022-01-16)
docs\ajax (0, 2022-01-16)
docs\ajax\index.html (47064, 2022-01-16)
docs\animations (0, 2022-01-16)
docs\animations\index.html (21687, 2022-01-16)
docs\authentication (0, 2022-01-16)
docs\authentication\index.html (26398, 2022-01-16)
docs\client-side-setup (0, 2022-01-16)
docs\client-side-setup\index.html (8291, 2022-01-16)
docs\cors (0, 2022-01-16)
docs\cors\img (0, 2022-01-16)
docs\cors\img\cors-preflight.png (20205, 2022-01-16)
docs\cors\img\cors-simple.png (10107, 2022-01-16)
docs\cors\index.html (15770, 2022-01-16)
docs\css (0, 2022-01-16)
docs\css\img (0, 2022-01-16)
docs\css\img\margins.png (18475, 2022-01-16)
docs\css\img\padding.png (15621, 2022-01-16)
docs\css\index.html (53452, 2022-01-16)
docs\cssframeworks (0, 2022-01-16)
docs\cssframeworks\index.html (61380, 2022-01-16)
docs\csslayout (0, 2022-01-16)
docs\csslayout\img (0, 2022-01-16)
docs\csslayout\img\bunny-sm.jpg (6721, 2022-01-16)
docs\csslayout\img\bunny.jpg (20541, 2022-01-16)
docs\csslayout\img\new.png (3351, 2022-01-16)
docs\csslayout\index.html (20925, 2022-01-16)
docs\deploy2aws (0, 2022-01-16)
docs\deploy2aws\img (0, 2022-01-16)
docs\deploy2aws\img\aws-dashboard.png (17636, 2022-01-16)
docs\deploy2aws\img\ec2-add-rules.png (163779, 2022-01-16)
docs\deploy2aws\img\ec2-amazon-linux-2.png (14642, 2022-01-16)
docs\deploy2aws\img\ec2-create-instance.png (7978, 2022-01-16)
docs\deploy2aws\img\ec2-import-key.png (44212, 2022-01-16)
docs\deploy2aws\img\ec2-instance-type.png (17584, 2022-01-16)
docs\deploy2aws\img\ec2-key-pair.png (93983, 2022-01-16)
... ...
# Tutorials Framework
This repo contains a general framework for writing tutorials in Markdown that are converted into HTML and merged with a single template. Source code highlighting is also done at build-time. The built tutorials are saved in the `docs/` directory so that you can easily publish them using [GitHub Pages](https://pages.github.com/).
All tutorial source files go into the `src/` directory. Create a new directory under `src/` for each tutorial. Each tutorial must have an `index.md` file for the tutorial content, and a `meta.json` file for meta-data. Currently the meta-data JSON may only have the properties `title` and `subtitle`.
```json
{
"title": "Title of the Tutorial",
"subtitle": "Subtitle of the tutorial"
}
```
Common library files go into `src/lib/` and common images go into `src/img/`.
# Template
The common template is in `src/template.html`. This is a simple [Handlebars](http://handlebarsjs.com/) template that is merged with the `meta.json` object from each tutorial directory, with a `contents` property added containing the tutorial contents converted into HTML. The merged and minified page will be saved to `docs/tutorial/index.html`, where `tutorial` is replaced with the name of the tutorial source folder.
# Table of Contents
The table of contents is in `src/index.html`, and it will be minimized into `docs/index.html`. This will be the home page of the GitHub Pages site, so it can be whatever you want it to be.
# Installing Dependencies
After cloning for the first time, run this command from the project root directory to install all dependencies (required Node.js):
```bash
npm install
```
# Building
To rebuild any tutorials that have changed since the last build, run this command:
```bash
npm run build
```
This runs the `scripts/build.js` script.
If the template changes, all tutorials will be rebuilt.
# Watching
Use this command while working on a tutorial:
```bash
npm start
```
This will build the tutorials and run `live-server` on the `docs/` directory. It will also watch the `src/` directory and automatically trigger a build if anything changes. This script is in `scripts/start.js`.
近期下载者:
相关文件:
收藏者: