Skip to content

Commit

Permalink
docs: Add starting contents
Browse files Browse the repository at this point in the history
  • Loading branch information
jcs090218 committed Nov 5, 2024
1 parent b1bde8d commit 3ccb79c
Show file tree
Hide file tree
Showing 42 changed files with 5,197 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "docs/themes/geekdoc"]
path = docs/themes/geekdoc
url = https://github.com/thegeeklab/hugo-geekdoc
11 changes: 11 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
vendor
_site
.bundle

/archetypes
.hugo_build.lock

/public

# macOS
.DS_Store
462 changes: 462 additions & 0 deletions docs/assets/sprites/regular.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
60 changes: 60 additions & 0 deletions docs/config/_default/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
baseURL: https://cl-qob.github.io/
title: Qob
theme: geekdoc

pygmentsUseClasses: true
pygmentsCodeFences: true
timeout: 180000
pluralizeListTitles: false

defaultContentLanguage: en

disablePathToLower: true
enableGitInfo: false

enableRobotsTXT: true

params:
geekdocToC: 3
geekdocLogo: './logo.png'
geekdocRepo: 'https://github.com/cl-qob/cli/'
geekdocEditPath: 'edit/master/docs/'

geekdocSearch: true
geekdocSearchShowParent: true

geekdocLegalNotice: "/tos"
geekdocPrivacyPolicy: "/tos"

geekdocContentLicense:
name: CC BY-SA 4.0
link: https://creativecommons.org/licenses/by-sa/4.0/

markup:
goldmark:
renderer:
unsafe: true
tableOfContents:
startLevel: 1
endLevel: 9

taxonomies:
tag: tags

outputs:
home:
- HTML
page:
- HTML
section:
- HTML
taxonomy:
- HTML
term:
- HTML

security:
exec:
allow:
- "^asciidoctor$"
8 changes: 8 additions & 0 deletions docs/config/_default/languages.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
en:
languageName: "English"
weight: 100

zh-TW:
languageName: "繁體中文"
weight: 90
153 changes: 153 additions & 0 deletions docs/content/FAQ/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
---
title: FAQ
weight: 900
---

Here is a list of general frequently asked questions.

{{< toc >}}

# 🔍 About Eask

## ❓ Do you need Node.JS to use Eask?

The answer is **NO**.

Eask builds native executable on every release, see our [release page](https://github.com/emacs-eask/cli/releases)
to download it! However, Node.JS is required if you are going to develop Eask!

## ❓ Who should use this tool?

Here are our suggestions; if you plan to work on an OS-specific package (never
going to other platforms), go for other tools. On the other hand, Eask aims to
provide the best consistency between each OS. Alternatively, if you want to
learn a tool that works everywhere, Eask is one of the best choices.

## ❓ Where can I download the Eask snapshot?

You can download the latest executable (snapshot) in our
[emacs-eask/binaries](https://github.com/emacs-eask/binaries)
repository!

# 🔍 Technology Choice

## ❓ Why Node.JS?

Node has better support on all kinds of terminal applications (compare to just
the shell script)! Like colorful interface, entire npm community, etc. So you
can build cross-platform software with fewer hassles! Especially after Microsoft
had bought the NPM inc, and would likely support their own system well.

Cask does not seem to support Windows (no WSL) after version `0.8.6`. In the
early versions, they have used Python, but due to the Python supports on Windows
are just not as good as Node.JS.

See [issue #140](https://github.com/emacs-eask/cli/issues/140) for more information!

## ❓ Why yargs?

[yargs](https://www.npmjs.com/package/yargs) has a very wide community; and it
has been used in many tools. It's cross-platform! And most importantly, this is
one of the tools that work well on Linux, macOS, and Windows.

There is also the major difference compared with Eask and other alternatives.
[Cask][], [makem.sh][], or [Eldev][] rely more on `batch` and `bash`. We chose a
different route and would like to hand over heavy tasks to a high-level
programming language, **`JavaScript`**. The development simply became easier,
since we don't need to care about different types of shells anymore!

The drawback is the NodeJS runtime, but we can simply pack the entire CLI
program into an executable! That way we would not need to install `Node` and
`npm` before using eask!

# 🔍 Usage

## ❓ Why am I getting the error package target `tar`/`el` not found while installing?

The example error message,

```
http://melpa.org/packages/lsp-mode-20220429.647.tar: Not found
```

The issue is caused by the mismatch from the backup archives. Generally, Eask
will pick up the latest `archive-contents` from sources unless you have been
pinging sources too many times. Then the source could block your IP for few
minutes.

You can either wait for few minutes for the source to remove you from their
black list. Or wait for the backup archives to update to the latest version. The
backup archives repository is [here](https://github.com/emacs-eask/archives).

## ❓ Why am I getting the error package is not installable?

The example error message,

```
Package not installable `helm'; make sure package archives are included
```

You would need to first ask yourself; where does the package came from and what
specific source holds this package information. From the above example message,
`helm` is listed on the `melpa` source. You would have to edit your **Eask**-file
like this:

```elisp
...
(source "melpa") ; <- add this line
(depends-on "helm")
```

## ❓ Why am I getting git errors with status 2?

If you get this sample error message:

```
Loading package information... done ✓
- Installing s (20210616.619)... Failed (status 2): git --no-pager remote get-url upstream .
...
```

You may have `bug-reference-prog-mode` enabled. It is not yet compatible with Eask and
should be disabled when running any of Eask’s commands.

See [this issue](https://github.com/emacs-eask/cli/issues/39#issuecomment-1150770740)
for more information.

## ❓ Why am I getting tar exited with status 2?

If you get this sample error message:

```
Created your-package-0.1.0.tar containing:
tar exited with status 2
Error: Process completed with exit code 1.
```

You might get this error while using the BSD tar. The workaround is to use
GNU tar instead.

```
(setq package-build-tar-executable "/path/to/gnu/tar")
```

In Windows, BSD tar is used by default. If you have Git installed, you can use
the tar executable from Git; it uses GNU tar.

Add the following code snippet to your Eask-file:

```
;; Use GNU tar in Windows
(when (memq system-type '(cygwin windows-nt ms-dos))
(setq package-build-tar-executable "C:/Program Files/Git/usr/bin/tar.exe"))
```


<!-- Links -->

[emacs-eask/archives]: https://github.com/emacs-eask/archives
[Cask]: https://github.com/cask/cask
[makem.sh]: https://github.com/alphapapa/makem.sh
[Eldev]: https://github.com/doublep/eldev
139 changes: 139 additions & 0 deletions docs/content/FAQ/_index.zh-tw.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
---
title: 常見問題
weight: 900
---

以下是一般常見問題列表。

{{< toc >}}

# 🔍 About Eask

## ❓ 您需要 Node.JS 才能使用 Eask 嗎?

答案是 ****.

Eask 在每個版本上構建本機可執行文件,您可以從我們的[發布頁面](https://github.com/emacs-eask/cli/releases)
下載! 但是,如果您要開發 Eask,那就需要需要 Node.JS!

## ❓ 誰應該使用這個工具?

這是我們的建議; 如果您打算使用特定於操作系統的軟件包(從不去其他平台),去尋找其他工具。
另一方面,Eask 旨在提供每個操作系統之間的最佳一致性。 或者,如果你想學習一個隨處可用的
工具,Eask 是最好的選擇之一。

## ❓ 我在哪裡可以下載 Eask snapshot?

您可以在我們的網站下載最新的可執行文件 (snapshot) [emacs-eask/binaries](https://github.com/emacs-eask/binaries)
代碼庫!

# 🔍 技術選擇

## ❓ 為什麼選擇 Node.JS?

Node 對各種終端應用程序有更好的支持(相比 shell 腳本)! 比如豐富多彩的界面,整個 npm 社區等等。
所以你可以更輕鬆地構建跨平台軟件! 尤其是在微軟之後已經購買了 NPM 公司,並且可能會很好地支持他
們自己的系統。

在 0.8.6 版本之後,Cask 似乎不支持 Windows(無 WSL)。 在裡面早期版本,他們使用的是 Python
但由於 Python 在 Windows 上的支持只是不如 Node.JS。

有關詳細信息,請參閱[問題 #140](https://github.com/emacs-eask/cli/issues/140)

## ❓ 為什麼是 yargs?

[yargs](https://www.npmjs.com/package/yargs) 擁有非常廣泛的社區; 和它
已經被用在很多工具中。 它是跨平台的! 最重要的是,這是在 Linux、macOS 和
Windows 上運行良好的工具之一。

與 Eask 和其他替代方案相比,也存在主要差異。[Cask][][makem.sh][][Eldev][] 更依賴於
`batch``bash`。 我們選擇了一個路線不同,想把繁重的任務交給高層編程語言,**`JavaScript`**
開髮變得更加容易,因為我們不再需要關心不同類型的 shell!

缺點是 NodeJS 的 runtime,但我們可以簡單地打包整個 CLI 程序變成可執行文件! 這樣我們就不需要安裝
`Node``npm`

# 🔍 用法

## ❓ 為什麼安裝時出現錯誤 package target `tar`/`el` not found?

示例錯誤消息,

```
http://melpa.org/packages/lsp-mode-20220429.647.tar: Not found
```

該問題是由備份存檔不匹配引起的。 一般來說,Eask 將從源中獲取最新的 `archive-contents` 除非你已經
ping 源太多次。 然後來源可能會阻止您的 IP 一段時間分鐘。

您可以等待幾分鐘讓消息來源將您從他們的黑名單。 或者等待備份存檔更新到最新版本。 這
備份存檔存儲庫在 [此處](https://github.com/emacs-eask/archives)

## ❓ 為什麼我收到錯誤包不可安裝?

示例錯誤消息,

```
Package not installable `helm'; make sure package archives are included
```

你需要先問問自己; 包裹從哪裡來,是什麼具體來源保存此包信息。 從上面的示例消息中,
`helm` 列在 `melpa` 源代碼中。 您將不得不編輯您的 **Eask** 文件像這樣:

```elisp
...
(source "melpa") ; <- add this line
(depends-on "helm")
```

## ❓ 為什麼我會收到狀態為 2 的 git 錯誤?

如果您收到此示例錯誤消息:

```
Loading package information... done ✓
- Installing s (20210616.619)... Failed (status 2): git --no-pager remote get-url upstream .
...
```

您可能啟用了 `bug-reference-prog-mode` 。 它還不兼容 Eask, 運行 Eask 的任何命令時都應禁用。

參見[問題 #39](https://github.com/emacs-eask/cli/issues/39#issuecomment-1150770740)
了解更多信息。

## ❓ 為什麼我會以狀態 2 退出 tar?

如果您收到此示例錯誤消息:

```
Created your-package-0.1.0.tar containing:
tar exited with status 2
Error: Process completed with exit code 1.
```

使用 BSD tar 時您可能會收到此錯誤。解決方法是使用 GNU tar 代替。

```
(setq package-build-tar-executable "/path/to/gnu/tar")
```

在 Windows 中,默認是使用 BSD tar。如果安裝了 Git,則可以使用 Git 中的 tar
可執行文件;它使用 GNU tar。

將以下代碼片段添加到您的 Eask 文件中:

```
;; 在Windows中使用 GNU tar
(when (memq system-type '(cygwin windows-nt ms-dos))
(setq package-build-tar-executable "C:/Program Files/Git/usr/bin/tar.exe"))
```


<!-- Links -->

[emacs-eask/archives]: https://github.com/emacs-eask/archives
[Cask]: https://github.com/cask/cask
[makem.sh]: https://github.com/alphapapa/makem.sh
[Eldev]: https://github.com/doublep/eldev
Loading

0 comments on commit 3ccb79c

Please sign in to comment.