give up GitBook turn to mmark

mikespook · mikespook · commit 1f8a9aec9554 · 2018-10-12T10:35:43.000+13:00
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,5 @@
+This work is licensed under the Attribution-NonCommercial-ShareAlike 3.0 Unported License. To
+view a copy of this license, visit 
+<http://creativecommons.org/licenses/by-nc-sa/3.0/>
+or send a letter to Creative Commons, 171 Second Street, Suite 300, San Francisco, California,
+94105, USA.
diff --git a/Makefile b/Makefile
@@ -0,0 +1,36 @@
+# This file copie and modified from https://github.com/miekg/learninggo/blob/master/Makefile
+MMARK=mmark
+
+all: learninggo.html
+
+.PHONY: learninggo.html
+learninggo.html:
+	$(MMARK) -html -head inc/head.html -css inc/learninggo.css learninggo.md > learninggo.html
+
+.PHONY: learninggo.xml
+learninggo.xml:
+	$(MMARK) learninggo.md > learninggo.xml
+
+.PHONY: learninggo.txt
+learninggo.txt: learninggo.xml
+	xml2rfc --v3 learninggo.xml
+
+.PHONY: learninggo-2.xml
+learninggo-2.xml:
+	$(MMARK) -2 learninggo.md > learninggo-2.xml
+
+.PHONY: learninggo-2.txt
+learninggo-2.txt: learninggo-2.xml
+	@# Using -n because it doesn't fully validate (RFC7749 is a limited format).
+	xml2rfc -n learninggo-2.xml
+
+.PHONY: ast
+ast:
+	$(MMARK) -ast learninggo.md
+
+.PHONY: test
+test:
+	$(MMARK) -html learninggo.md
+
+clean:
+	rm -f learninggo.html
diff --git a/README.md b/README.md
@@ -1,54 +1,17 @@
-# 前言
+# 学习 Go 语言
 
-> “Go 是面向对象的语言吗？是也不是。” —— GO 开发者在 FAQ 中如是说到
+这是《学习 Go 语言》的第二版。
 
-## 关于本书
+这是一本关于来自 Google 的 Go 语言的快速入门。本书的第一版翻译自 Miek Gieben 开始于 2010 年的开源书籍 “Leaning Go”。从第二版开始，中文内容将脱离原版英文翻译，独立编写。
 
-《学习 Go 语言（第二版）》是一本关于来自 Google 的 Go 语言的快速入门。本书的第一版翻译自 Miek Gieben 开始于 2010 年的开源书籍 “Leaning Go”。从第二版开始，中文内容将脱离原版英文翻译，独立编写。并保持内容与 Go 语言的最新发行版本一致。
+但是尽管中文版本独立编写，仍然得感谢 [Miek Gieben](https://miek.nl) 在 [Leaning Go](https://miek.nl/go/) 中构建起来的内容框架。
+而 Miek 用 Go 语言开发的 markdown 处理工具 [mmark](https://github.com/mmarkdown/mmark) 也将作为本开源书籍的生成工具。
 
-这本书的目标是为这个新的、革命性的语言提供一个 指南。所以本书将假设你已经在系统中安装了 Go，但读者仍然可以在附录中找到流行操作系统的安装指南。
+## 本书目标
 
-## 读者
+这本书的目标是为 Go 语言这个年轻的、革命性的计算机语言提供一个快速指南。
 
-这本书的目标读者是那些熟悉编程,并且了解某些编程语言,例如 C，C++，Java，PHP，Python 等等。请注意，这不是一本教你如何编程的书。本书的主要目标是教你如何使用 Go。学习某样新语言的最佳的方式就是通过编写程序来探索它。因此每章都包含了若干练习、答案和答案解析来让你熟悉这个语言。每个练习都有独立的编号。在练习编号后面的圆括号中标明了该题的难度。
-
-1. 易
-2. 中
-3. 难
-
-并且为了帮助索引，每个题目都有一个简短的标题。例如：
-
-> Q1. （中） map 函数
-
-编号 Q1 的这个问题是一道中等难度的关于 map\(\) 函数的练习。相关答案会在练习的下一页提供。答案的顺序和练习一致并使用类似的编号方式，以 A 开头并附带序号。例如：
-
-> A1. map 函数
-
-答案只是提供一种思路和参考，不是绝对的标准，也不是问题的最佳解。对于那些没有答案的练习，它们将用星号标记出来。
-
-## 主要内容
-
-1. 简介
-
-   本章将讨论语言中可用的基本类型、变量和控制结构
-
-2. 函数与数据
-
-   函数是 Go 程序中的重要基本部件，通过函数可以对数据进行操作。同时本章也会对 Go 的垃圾自动回收和内存分配进行简要介绍
-
-3. 包与模块
-
-   通过包可以整合功能相关的函数与数据，而模块可以更加方便的管理包。同时如何编写文档和进行单元测试也会是本章的重要内容
-
-4. 接口
-
-   Go 语言的接口与传统意义的面相对象语言的接口大相径庭，而接口的设计是这个语言的核心思想之一
-
-5. 并发
-
-   通过引入关键字 `go` ，Go 语言使并发程序的编写变得异常轻松。而在这个语言中的并发单元是一种轻线程 `goroutine`。而引入 `channel` 来在 `goroutine` 之间通讯也使得传统的并发编程任务变得轻松起来
-
-6. 通讯
-
-   本章会对标准库中的文件读写、网络通讯等常用库进行简单介绍，并示范如何从头编写一个完整的 Go 程序
+## 编译
 
+* 下载二进制版本的 mmark 或使用 `go get github.com/mmarkdown/mmark` 命令直接安装
+* 运行 `make` 生成 html 文件
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -1,9 +1,9 @@
-# Table of contents
+# 目录
 
-* [前言](README.md)
+* [前言](preface.md)
 
 ## 简介
 
-* [简介](jian-jie/jian-jie.md)
-* [官方文档](jian-jie/guan-fang-wen-dang.md)
+* [简介](introduction/introduction.md)
+* [官方文档](introduction/official-docs.md)
 
diff --git a/introduction/introduction.md b/introduction/introduction.md
diff --git a/introduction/official-docs.md b/introduction/official-docs.md
diff --git a/preface.md b/preface.md
@@ -0,0 +1,62 @@
+# 前言
+
+> “Go 是面向对象的语言吗？是也不是。” —— GO 开发者在 FAQ 中如是说到
+
+## 关于本书
+
+《学习 Go 语言（第二版）》是一本关于来自 Google 的 Go 语言的快速入门。本书的第一版翻译自 Miek Gieben 开始于 2010 年的开源书籍 “Leaning Go”。从第二版开始，中文内容将脱离严格翻译原英文内容，重新编排和撰写。并保持内容与 Go 语言的最新发行版本一致。
+
+这本书的目标是为这个新的、革命性的语言提供一个快速指南。所以本书将假设你已经在系统中安装了 Go，但读者仍然可以在附录中找到流行操作系统的安装指南。
+
+本书使用 [Attribution-NonCommercial-ShareAlike 3.0 Unported License](http://creativecommons.org/licenses/by-nc-sa/3.0/) 授权。
+本书中的所有示例代码使用 Apache License version 2.0 协议授权。
+
+## 致谢
+
+感谢所有为英文原版 Leaning Go 和《学习 Go 语言》第一版作出任何贡献的朋友们。
+
+无论如何得感谢 Miek Gieben 在 Leaning Go 中构建起来的良好的内容框架，和他使用 Go 语言开发的 markdown 处理工具 mmark。没有他的分享与贡献，本书的所有内容都无法成型。
+
+## 读者
+
+这本书的目标读者是那些有基本的编程概念,并且已经对解某些主流编程语言有所了解。主流编程语言包括但并不限于 C，C++，Java，PHP，Python 等等。请注意，这不是一本教你如何编程的书。本书的主要目标是教你如何使用 Go。学习某样新语言的最佳的方式就是通过编写程序来探索它。因此每章都包含了若干练习、答案和答案解析来让你熟悉这个语言。每个练习都有独立的编号。在练习编号后面的圆括号中标明了该题的难度。
+
+1. 易
+2. 中
+3. 难
+
+并且为了帮助索引，每个题目都有一个简短的标题。例如：
+
+> Q1. （中） map 函数
+
+编号 Q1 的这个问题是一道中等难度的关于 map\(\) 函数的练习。相关答案会在练习的下一页提供。答案的顺序和练习一致并使用类似的编号方式，以 A 开头并附带序号。例如：
+
+> A1. map 函数
+
+答案只是提供一种思路和参考，不是绝对的标准，也不是问题的最佳解。对于那些没有答案的练习，它们将用星号标记出来。
+
+## 主要内容
+
+1. 简介
+
+   本章将讨论语言中可用的基本类型、变量和控制结构
+
+2. 函数与数据
+
+   函数是 Go 程序中的重要基本部件，通过函数可以对数据进行操作。同时本章也会对 Go 的垃圾自动回收和内存分配进行简要介绍
+
+3. 包与模块
+
+   通过包可以整合功能相关的函数与数据，而模块可以更加方便的管理包。同时如何编写文档和进行单元测试也会是本章的重要内容
+
+4. 接口
+
+   Go 语言的接口与传统意义的面相对象语言的接口大相径庭，而接口的设计是这个语言的核心思想之一
+
+5. 并发
+
+   通过引入关键字 `go` ，Go 语言使并发程序的编写变得异常轻松。而在这个语言中的并发单元是一种轻线程 `goroutine`。而引入 `channel` 来在 `goroutine` 之间通讯也使得传统的并发编程任务变得轻松起来
+
+6. 通讯
+
+   本章会对标准库中的文件读写、网络通讯等常用库进行简单介绍，并示范如何从头编写一个完整的 Go 程序
