Skip to content

Commit f1cab81

Browse files
committed
docs: add doc
1 parent a68926f commit f1cab81

File tree

6 files changed

+76
-20
lines changed

6 files changed

+76
-20
lines changed

docs/content/Development-API/_index.en.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,16 @@ then,
129129
(message "%s" (eask-command)) ; init
130130
```
131131

132+
## 🔍 Function: eask-command-check (`version`)
133+
134+
Report error if the current command requires minimum `version`.
135+
136+
```elisp
137+
(eask-start
138+
(eask-command-check "27.1") ; The command requires 27.1 and above!
139+
...
140+
```
141+
132142
## 🔍 Function: eask-command-p (`commands`)
133143

134144
Return t if COMMANDS is the current command.

docs/content/Development-API/_index.zh-tw.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,16 @@ eask init
128128
(message "%s" (eask-command)) ; init
129129
```
130130

131+
## 🔍 函式: eask-command-check (`version`)
132+
133+
如果目前的指令需要最低的 `version` 就會報錯。
134+
135+
```elisp
136+
(eask-start
137+
(eask-command-check "27.1") ; 此指令需要 27.1 及以上版本!
138+
...
139+
```
140+
131141
## 🔍 函式: eask-command-p (`commands`)
132142

133143
如果 COMMANDS 是目前命令,則傳回 `t`

docs/content/Getting-Started/Basic-Usage/_index.en.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ Commands:
4949
info Display information about the current package
5050
init [files..] Initialize project to use Eask
5151
install-deps Automatically install package dependencies [aliases: install-dependencies, prepare]
52+
install-file [files..] Install packages from files, .tar files, or directories
53+
install-vc [specs..] Install packages directly from the version control
5254
install [names..] Install packages
5355
keywords List available keywords that can be used in the header section
5456
link <action> Manage links

docs/content/Getting-Started/Basic-Usage/_index.zh-tw.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ Commands:
4646
info Display information about the current package
4747
init [files..] Initialize project to use Eask
4848
install-deps Automatically install package dependencies [aliases: install-dependencies, prepare]
49+
install-file [files..] Install packages from files, .tar files, or directories
50+
install-vc [specs..] Install packages directly from the version control
4951
install [names..] Install packages
5052
keywords List available keywords that can be used in the header section
5153
link <action> Manage links

docs/content/Getting-Started/Commands-and-options/_index.en.md

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,26 @@ Display the state of the workspace.
114114
eask [GLOBAL-OPTIONS] status
115115
```
116116

117+
## 🔍 eask install
118+
119+
To install packages.
120+
121+
```sh
122+
eask [GLOBAL-OPTIONS] install [PACKAGES..]
123+
```
124+
125+
Install packages by specifying arguments:
126+
127+
```sh
128+
eask install auto-complete helm magit
129+
```
130+
131+
Or else, it will install the package from the current development:
132+
133+
```sh
134+
eask install
135+
```
136+
117137
## 🔍 eask install-deps
118138

119139
To install all dependencies.
@@ -128,24 +148,20 @@ eask [GLOBAL-OPTIONS] install-deps [--dev]
128148
💡 Specify option [--dev] to install dependencies from the development scope.
129149
{{< /hint >}}
130150

131-
## 🔍 eask install
151+
## 🔍 eask install-file
132152

133-
To install packages.
153+
Install packages from files, `.tar` files, or directories.
134154

135155
```sh
136-
eask [GLOBAL-OPTIONS] install [PACKAGES..]
156+
eask [GLOBAL-OPTIONS] install-file [FILES..]
137157
```
138158

139-
Install packages by specifying arguments:
159+
## 🔍 eask install-vc
140160

141-
```sh
142-
eask install auto-complete helm magit
143-
```
144-
145-
Or else, it will install the package from the current development:
161+
Install packages directly from the version control.
146162

147163
```sh
148-
eask install
164+
eask [GLOBAL-OPTIONS] install-vc [SPECS..]
149165
```
150166

151167
## 🔍 eask uninstall

docs/content/Getting-Started/Commands-and-options/_index.zh-tw.md

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,26 @@ eask [GLOBAL-OPTIONS] info
112112
eask [GLOBAL-OPTIONS] status
113113
```
114114

115+
## 🔍 eask install
116+
117+
安裝軟件包。
118+
119+
```sh
120+
eask [GLOBAL-OPTIONS] install [PACKAGES..]
121+
```
122+
123+
通過指定參數安裝包:
124+
125+
```sh
126+
eask install auto-complete helm magit
127+
```
128+
129+
否則,它將安裝當前開發的包:
130+
131+
```sh
132+
eask install
133+
```
134+
115135
## 🔍 eask install-deps
116136

117137
安裝所有依賴項。
@@ -126,24 +146,20 @@ eask [GLOBAL-OPTIONS] install-deps [--dev]
126146
💡 指定選項 [--dev] 從開發範圍安裝依賴項。
127147
{{< /hint >}}
128148

129-
## 🔍 eask install
149+
## 🔍 eask install-file
130150

131-
安裝軟件包
151+
從檔案、`.tar` 檔案或目錄安裝套件
132152

133153
```sh
134-
eask [GLOBAL-OPTIONS] install [PACKAGES..]
154+
eask [GLOBAL-OPTIONS] install-file [FILES..]
135155
```
136156

137-
通過指定參數安裝包:
157+
## 🔍 eask install-vc
138158

139-
```sh
140-
eask install auto-complete helm magit
141-
```
142-
143-
否則,它將安裝當前開發的包:
159+
直接從版本控制安裝套件。
144160

145161
```sh
146-
eask install
162+
eask [GLOBAL-OPTIONS] install-vc [SPECS..]
147163
```
148164

149165
## 🔍 eask uninstall

0 commit comments

Comments
 (0)