Merge branch 'master' of https://github.com/wa-lang/man

wa-lang · Apr 10, 2024 · 3b9e02f · 3b9e02f
2 parents 725837f + 2999f2d
commit 3b9e02f
Show file tree

Hide file tree

Showing 28 changed files with 855 additions and 32 deletions.
diff --git a/.github/workflows/book.yml b/.github/workflows/book.yml
@@ -1,4 +1,4 @@
-name: mdbook
+name: mnbook
 on:
   push:
     branches:
@@ -18,11 +18,13 @@ jobs:
       - name: Git checkout
         uses: actions/checkout@v2
 
-      - name: Setup mdBook
-        uses: peaceiris/actions-mdbook@v1
+      - name: Set up Go
+        uses: actions/setup-go@v2
         with:
-          mdbook-version: '0.4.10'
-          # mdbook-version: 'latest'
+          go-version: 1.21
+
+      - run: go version
+      - run: go install github.com/wa-lang/mnbook@latest
 
       - run: make build
 

diff --git a/LICENSE b/LICENSE
diff --git a/Makefile b/Makefile
@@ -1,16 +1,18 @@
+# go install github.com/wa-lang/mnbook@latest
+
 default:
-	mdbook serve
+	mnbook serve
 
 build:
 	-rm book
-	mdbook build
+	mnbook build
 	make -C en build
 	-rm book/.gitignore
 	-rm -rf book/.git
 
 deploy:
 	-rm book
-	mdbook build
+	mnbook build
 	make -C en build
 	-rm book/.gitignore
 	-rm -rf book/.git

diff --git a/README.md b/README.md
@@ -1,14 +1,14 @@
 # Wa-lang's Manual
 
-![](en/cover.png)
+<img width="520px"  height="660px" src="en/cover.svg" />
 
 - Online manual：[https://wa-lang.github.io/man/en/](https://wa-lang.github.io/man/en/)
 - Online manual(Chinese)：[https://wa-lang.org/man/](https://wa-lang.org/man/)
 - Github Repo: [https://github.com/wa-lang/man](https://github.com/wa-lang/man)
 
 # 凹语言手册
 
-![](cover.png)
+<img width="520px"  height="660px" src="cover.svg" />
 
 - 在线地址：[https://wa-lang.org/man/](https://wa-lang.org/man/)
 - 在线地址(英文)：[https://wa-lang.github.io/man/en/](https://wa-lang.github.io/man/en/)

diff --git a/chs/1.安装及入门/1.1.你好凹语言.md b/chs/1.安装及入门/1.1.你好凹语言.md
@@ -26,7 +26,7 @@ func add(a: i32, b: i32) => i32 {
 }
 ```
 
-其中`//`开始的是行注释，`import`关键字导入了2个包准库的包，`global`关键字定义了一个全局变量，并给了2023的初始值。`func`关键字定义了`main`函数和`add`函数。`main`函数是程序的入口，其中通过内置的`println`函数打印了“你好，凹语言！”，同时使用`fmt`包的`Println`字符串和整数表达式的结果。在`main`函数还使用了全局的`year`变量，此外还调用了`add`函数并打印了返回值。`add`函数有2个输入参数和一个返回值。
+其中`//`开始的是行注释，`import`关键字导入了2个标准库的包，`global`关键字定义了一个全局变量，并给了2023的初始值。`func`关键字定义了`main`函数和`add`函数。`main`函数是程序的入口，其中通过内置的`println`函数打印了“你好，凹语言！”，同时使用`fmt`包的`Println`字符串和整数表达式的结果。在`main`函数还使用了全局的`year`变量，此外还调用了`add`函数并打印了返回值。`add`函数有2个输入参数和一个返回值。
 
 如果在本地已经安装有凹语言的`wa`命令（安装方式参考1.2节），可以输入以下命令执行：
 

diff --git a/chs/1.安装及入门/1.3.命令行功能.md b/chs/1.安装及入门/1.3.命令行功能.md
@@ -122,7 +122,7 @@ $ wa run ./output/hello.wasm
 ...
 ```
 
-如果不带参赛执行 `wa run` 命令，表示编译并执行当前凹语言工程，会先构建出 `output/hello.wasm` 然后再执行。
+如果不带参数执行 `wa run` 命令，表示编译并执行当前凹语言工程，会先构建出 `output/hello.wasm` 然后再执行。
 
 ### 1.3.4 格式化代码
 

diff --git a/chs/3.基础数据类型/3.1.局部变量声明.md b/chs/3.基础数据类型/3.1.局部变量声明.md
@@ -6,15 +6,15 @@
 局部变量名: 数据类型 = 初始值
 ```
 
-与全部变量和常量不同的是：局部变量的声明不以关键字开始；在声明局部变量时，如果省略 `= 初始值` 部分，则该变量将以0值初始化，如：
+与全局变量和常量不同的是：局部变量的声明不以关键字开始；在声明局部变量时，如果省略 `= 初始值` 部分，则该变量将以0值初始化，如：
 
 ```wa
     aI32: i32 = 42
     aString: string = "你好"
     aF32: f32  // 0.0
 ```
 
-另一种常用的声明局部变量的语法使用快捷定义符 `:=` ，语法如下：
+另一种常用的声明局部变量的语法是使用快捷定义符 `:=` ，语法如下：
 
 ```wa
 局部变量名 := 表达式

diff --git a/chs/3.基础数据类型/3.2.整数.md b/chs/3.基础数据类型/3.2.整数.md
@@ -54,7 +54,7 @@
 - `&`：按位取与，两个操作数类型必须一致，返回值类型与操作数一致；
 - `|`：按位取或，两个操作数类型必须一致，返回值类型与操作数一致；
 - `^`：按位取异或，两个操作数类型必须一致，返回值类型与操作数一致；
-- `&^`：按位清空，两个操作数类型必须一致，返回值类型与操作数一致。对 `z = x ^& y`，设 `xn`、`yn`、`zn` 分别为 `x`、`y`、`z` 的第n位，则当 `yn` 为1时 `zn` 为0，否则 `zn` 等于 `xn`。该运算等价于 `z = x & (^y)`；
+- `&^`：按位清空，两个操作数类型必须一致，返回值类型与操作数一致。对 `z = x &^ y`，设 `xn`、`yn`、`zn` 分别为 `x`、`y`、`z` 的第n位，则当 `yn` 为1时 `zn` 为0，否则 `zn` 等于 `xn`。该运算等价于 `z = x & (^y)`；
 - `<<`：左移，对 `z = x << y`，`z` 的类型与 `x` 一致，`y` 必须为大于0的整数，移位时低位补0；
 - `>>`：右移，对 `z = x >> y`，`z` 的类型与 `x` 一致，`y` 必须为大于0的整数，移位时高位补0。
 

diff --git a/chs/3.基础数据类型/3.4.字符串.md b/chs/3.基础数据类型/3.4.字符串.md
@@ -35,7 +35,7 @@
     println(s[1:3]) // ��
 ```
 
-`s[m:n]` 用法从第`n`个字节处开始截取，返回的字串长度为 `n-m` 字节。若省略 `m` 则表示从字符串开始截取，若省略 `n` 则表示截取至字符串末尾，例如：
+`s[m:n]` 用法从第`m`个字节处开始截取，返回的字串长度为 `n-m` 字节。若省略 `m` 则表示从字符串开始截取，若省略 `n` 则表示截取至字符串末尾，例如：
 ```wa
     s := "abcdefg"
     println(s[:3]) // abc

diff --git a/chs/9.附录/a-spec.md b/chs/9.附录/a-spec.md
@@ -25,7 +25,7 @@ ImportPath  = string_lit .
 PackageName = identifier .
 ```
 
-imort 关键字用于导入包，导入的包还可以被重新命名（对应PackageName）。
+import 关键字用于导入包，导入的包还可以被重新命名（对应PackageName）。
 
 以下代码是一个凹源文件的对应例子：
 

diff --git a/cover.png b/cover.png
diff --git a/cover.svg b/cover.svg
diff --git a/en/3.BasicTypes/3.2.Integers.md b/en/3.BasicTypes/3.2.Integers.md
@@ -58,7 +58,7 @@ Integers(except Boolean) support the following binary bit operations:
 - `&`: bitwise AND, the two operand types must be consistent, the type of return value is same with operands;
 - `|`: Bitwise OR, the two operand types must be consistent, the type of return value is same with operands;
 - `^`: Bitwise XOR, the two operand types must be consistent, the type of return value is same with operands;
-- `&^`: clear bitwise, the two operand types must be consistent, the type of return value is same with operands. For `z = x ^& y`, let `xn`, `yn`, `zn` be the nth bit of `x`, `y`, `z` respectively, then when `yn` is 1, `zn ` is 0, otherwise `zn` is equal to `xn`. This operation is equivalent to `z = x & (^y)`;
+- `&^`: clear bitwise, the two operand types must be consistent, the type of return value is same with operands. For `z = x &^ y`, let `xn`, `yn`, `zn` be the nth bit of `x`, `y`, `z` respectively, then when `yn` is 1, `zn ` is 0, otherwise `zn` is equal to `xn`. This operation is equivalent to `z = x & (^y)`;
 - `<<`: Left shift, for `z = x << y`, the type of `z` is consistent with `x`, `y` must be an integer greater than 0, and the low-order bit is filled with 0 when shifting;
 - `>>`: Right shift, for `z = x >> y`, the type of `z` is consistent with `x`, `y` must be an integer greater than 0, and the high bit is filled with 0 when shifting.
 

diff --git a/en/3.BasicTypes/3.4.String.md b/en/3.BasicTypes/3.4.String.md
@@ -39,7 +39,7 @@ In this usage, the subscripted units within `[]` are bytes, not characters. If t
     println(s[1:3]) // ��
 ```
 
-`s[m:n]` operation starts from the `n`th byte, and the length of the returned string is `n-m` bytes. If `m` is omitted, it means start from the beginning of the string. If `n` is omitted, it means intercepting to the end of the string. For example:
+`s[m:n]` operation starts from the `m`th byte, and the length of the returned string is `n-m` bytes. If `m` is omitted, it means start from the beginning of the string. If `n` is omitted, it means intercepting to the end of the string. For example:
 ```wa
     s := "abcdefg"
     println(s[:3]) // abc

diff --git a/en/Makefile b/en/Makefile
@@ -1,10 +1,10 @@
 default:
-	mdbook serve
+	mnbook serve
 
 build:
-	-rm ../book/en
+	-rm -rf ../book/en
 	mkdir -p ../book/en
-	mdbook build -d ../book/en
+	mnbook build && mv ./book ./en && mv ./en ../book/
 	-rm ../book/en/.gitignore
 
 clean:

diff --git a/en/README.md b/en/README.md
@@ -2,6 +2,8 @@
 
 ***Ending's law: "Any application that can be compiled to WebAssembly, will be compiled to WebAssembly eventually."***
 
-![](cover.png)
+<img width="520px"  height="660px" src="cover.svg" />
 
-- Online manual：[https://wa-lang.org/man/](https://wa-lang.org/man/)
+- Github: [https://github.com/wa-lang/wa](https://github.com/wa-lang/wa)
+- Online manual: [https://wa-lang.github.io/man/en/](https://wa-lang.github.io/man/en/)
+- Online manual(Chinese): [https://wa-lang.org/man/](https://wa-lang.org/man/)
diff --git a/en/SUMMARY.md b/en/SUMMARY.md
@@ -4,7 +4,7 @@
 [Wa-lang's manual](index.md)
 [Preface](preface.md)
 
-* [1.Install And Get Start](./1.InstallAndGetStart/readme.md)
+* [Install And Get Start](./1.InstallAndGetStart/readme.md)
   - [hello world](./1.InstallAndGetStart/1.1.HelloWorld.md)
   - [Install Wa-lang Compiler](./1.InstallAndGetStart/1.2.Install.md)
   - [wa command line](./1.InstallAndGetStart/1.3.Command.md)

diff --git a/en/cover.png b/en/cover.png
diff --git a/en/cover.svg b/en/cover.svg
diff --git a/en/index.md b/en/index.md
@@ -1,7 +1,7 @@
 # Wa-lang's Manual
 
-![](cover.png)
+![](cover.svg)
 
-- Online manual：[https://wa-lang.github.io/man/en/](https://wa-lang.github.io/man/en/)
-- Online manual(Chinese)：[https://wa-lang.org/man/](https://wa-lang.org/man/)
-- Github Repo: [https://github.com/wa-lang/man](https://github.com/wa-lang/man)
+- Github: [https://github.com/wa-lang/wa](https://github.com/wa-lang/wa)
+- Online manual: [https://wa-lang.github.io/man/en/](https://wa-lang.github.io/man/en/)
+- Online manual(Chinese): [https://wa-lang.org/man/](https://wa-lang.org/man/)
diff --git a/en/wa-man-en.drawio b/en/wa-man-en.drawio
diff --git a/icons/Makefile b/icons/Makefile
@@ -0,0 +1,4 @@
+default:
+	base64 -i logo-animate1.svg -o logo-animate1.base64.txt
+	base64 -i logo-round-color-LightSeaGreen.svg -o logo-round-color-LightSeaGreen.base64.txt
+clean:
diff --git a/icons/logo-animate1.base64.txt b/icons/logo-animate1.base64.txt
@@ -0,0 +1 @@
+PCEtLSAKLy8g54mI5p2DIEAyMDE5IOWHueivreiogCDkvZzogIXjgILkv53nlZnmiYDmnInmnYPliKnjgIIKLy8gaHR0cHM6Ly93YS1sYW5nLm9yZwotLT4KCjxzdmcgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB2aWV3Qm94PSIwIDAgNDAwIDQwMCIgd2lkdGg9IjQwMCIgaGVpZ2h0PSI0MDAiIGZpbGw9Im5vbmUiPgoKICA8cGF0aCBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGNsaXAtcnVsZT0iZXZlbm9kZCIgZD0iTTUwIDcwQzUwIDU4Ljk1NDMgNTguOTU0MyA1MCA3MCA1MEgxMzBDMTQxLjA0NiA1MCAxNTAgNTguOTU0MyAxNTAgNzBWNzRWMTMwVjE1MEgyNTBWMTMwVjc0VjcwQzI1MCA1OC45NTQzIDI1OC45NTQgNTAgMjcwIDUwSDMzMEMzNDEuMDQ2IDUwIDM1MCA1OC45NTQzIDM1MCA3MFY5NFYxMzBWMzMwQzM1MCAzNDEuMDQ2IDM0MS4wNDYgMzUwIDMzMCAzNTBINzBDNTguOTU0MyAzNTAgNTAgMzQxLjA0NiA1MCAzMzBWMTMwVjk0VjcwWiIgZmlsbD0iTGlnaHRTZWFHcmVlbiIgLz4KCiAgPGNpcmNsZSBjeD0iMTAwIiBjeT0iMTAwIiByPSI1IiBzdHJva2U9ImJsYWNrIiBzdHJva2Utd2lkdGg9IjAiIGZpbGw9IndoaXRlIj4KICAgIDxhbmltYXRlIGF0dHJpYnV0ZU5hbWU9InIiIHZhbHVlcz0iMDs1OzU7MCIgZHVyPSIxcyIgcmVwZWF0Q291bnQ9IjEiIC8+CiAgPC9jaXJjbGU+CgogIDxjaXJjbGUgY3g9IjMwMCIgY3k9IjEwMCIgcj0iNSIgc3Ryb2tlPSJibGFjayIgc3Ryb2tlLXdpZHRoPSIwIiBmaWxsPSJ3aGl0ZSI+CiAgICA8YW5pbWF0ZSBhdHRyaWJ1dGVOYW1lPSJyIiB2YWx1ZXM9IjA7NTs1OzAiIGR1cj0iMXMiIHJlcGVhdENvdW50PSIxIiAvPgogIDwvY2lyY2xlPgoKICA8cGF0aCBkPSJNMjAwIDIzMEwyMzQgMjY0TDI2OCAyMzBNMjAwIDIzMEwxNjYgMjY0TDEzMiAyMzAiIGZpbGw9Im5vbmUiIHN0cm9rZT0id2hpdGUiIHN0cm9rZS13aWR0aD0iOCIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIiBzdHJva2UtZGFzaGFycmF5PSIwLDAsMCwxOTIiPgogICAgPGFuaW1hdGUgYXR0cmlidXRlVHlwZT0iWE1MIiBhdHRyaWJ1dGVOYW1lPSJzdHJva2UtZGFzaGFycmF5IiB2YWx1ZXM9IjAsMCwwLDE5MjswLDk2LDk2LDA7IDE5MiwwLDAsMCIga2V5VGltZXM9IjA7IDAuNTsxIiBmaWxsPSJmcmVlemUiIGR1cj0iMS41cyIgcmVwZWF0Q291bnQ9IjEiIC8+CiAgPC9wYXRoPgoKPC9zdmc+
diff --git a/icons/logo-animate1.svg b/icons/logo-animate1.svg
diff --git a/icons/logo-round-color-LightSeaGreen.base64.txt b/icons/logo-round-color-LightSeaGreen.base64.txt
@@ -0,0 +1 @@
+CjwhLS0KLy8g54mI5p2DIEAyMDE5IOWHueivreiogCDkvZzogIXjgILkv53nlZnmiYDmnInmnYPliKnjgIIKLy8gaHR0cHM6Ly93YS1sYW5nLm9yZwotLT4KCjxzdmcgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIgoJdmlld0JveD0iMCAwIDQwMCA0MDAiIHdpZHRoPSI0MDAiIGhlaWdodD0iNDAwIgoJc3R5bGU9ImJvcmRlcjogMHB4IHNvbGlkIHJlZCIKPgoKPHBhdGgKCXN0cm9rZT0ibm9uZSIgZmlsbD0iTGlnaHRTZWFHcmVlbiIKCWQ9Ik02MCw1MCBoOTAgdjEwMCBoMTAwIHYtMTAwIGg5MCBsMTAsMTAgdjI4MCBsLTEwLDEwIGgtMjgwIGwtMTAsLTEwIHYtMjgwIgovPgoKPHBhdGgKCXN0cm9rZT0ibm9uZSIgZmlsbD0id2hpdGUiCglkPSJNMTAwLDEwMCBtLTUsLTUgaDEwIHYxMCBoLTEwIgovPgoKPHBhdGgKCXN0cm9rZT0ibm9uZSIgZmlsbD0id2hpdGUiCglkPSJNNDAwLDEwMCBtLTEwMCwwIG0tNSwtNSBoMTAgdjEwIGgtMTAiCi8+Cgo8cGF0aAoJc3Ryb2tlPSJ3aGl0ZSIgZmlsbD0ibm9uZSIgc3Ryb2tlLXdpZHRoPSI4IiBzdHJva2UtbGluZWNhcD0icm91bmQiCglkPSJNMjAwLDIzMCBsMzQsMzQgbDM0LC0zNCBNMjAwLDIzMCBsLTM0LDM0IGwtMzQsLTM0IgovPgoKPC9zdmc+Cg==
diff --git a/icons/logo-round-color-LightSeaGreen.svg b/icons/logo-round-color-LightSeaGreen.svg
diff --git a/index.md b/index.md
@@ -1,4 +1,4 @@
-![](cover.png)
+![](cover.svg)
 
 - 在线地址：[https://wa-lang.org/man/](https://wa-lang.org/man/)
 - 在线地址(英文)：[https://wa-lang.github.io/man/en/](https://wa-lang.github.io/man/en/)

diff --git a/wa-man.drawio b/wa-man.drawio