Skip to content

Commit

Permalink
docs: Improve reading UX
Browse files Browse the repository at this point in the history
  • Loading branch information
jcs090218 committed Nov 19, 2024
1 parent 563d75f commit d25e70b
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 25 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ a directory with the following structure:
└── {package-file}.el
```

## Directory Structure Explained
## 📂 Directory Structure Explained

The following is a high-level overview of each of the files.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ weight: 350
└── {package-file}.el
```

## 目錄結構說明
## 📂 目錄結構說明

以下是每個文件的高級概述。

Expand Down
24 changes: 13 additions & 11 deletions docs/content/Getting-Started/Quick-Start/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,16 @@ weight: 100
Using Eask as your Emacs package management tool.

{{< hint info >}}
The installation are cross-platform, using [npm](https://www.npmjs.com/).
For instructions about how to install Eask with other methods, see [install](https://emacs-eask.github.io/Getting-Started/Install-Eask/).
The installation is cross-platform and uses [npm](https://www.npmjs.com/).
For instructions on how to install Eask using other methods, see the
[install](https://emacs-eask.github.io/Getting-Started/Install-Eask/)
section.

It is required to have [Git installed](https://git-scm.com/downloads)
to run this tutorial.
{{< /hint >}}

## Step 1: Setup NodeJS runtime and `npm`
## 🔍 Step 1: Setup NodeJS runtime and `npm`

Please check out their official site
[here](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm#using-a-node-installer-to-install-nodejs-and-npm)
Expand All @@ -26,7 +28,7 @@ and install `NodeJS` and `npm` corresponds to your current operating system
from our [release](https://github.com/emacs-eask/cli/releases) page.
{{< /hint >}}

## Step 2: Install Eask
## 🔍 Step 2: Install Eask

```sh
$ npm install -g @emacs-eask/cli
Expand All @@ -38,7 +40,7 @@ To verify your new installation:
$ eask --version
```

## Step 3: Navigate to an existing project or create a new project
## 🔍 Step 3: Navigate to an existing project or create a new project

If you already have an existing elisp project, navigate to the project root
folder.
Expand All @@ -55,7 +57,7 @@ $ eask create package project-name

It should create a folder named `project-name` in your current working directory.

## Step 4: Create `Eask`-file
## 🔍 Step 4: Create `Eask`-file

Skip this step if you chose to create the project with **`eask create`**!

Expand Down Expand Up @@ -98,7 +100,7 @@ Is this OK? (yes) yes ⏎

You should be able to see an `Eask` file in your project folder. 🎉🎊

## Step 5: Start the package development
## 🔍 Step 5: Start the package development

To check your package information, run:

Expand All @@ -125,7 +127,7 @@ dist

From the start, you would not have any `dependencies` and `devDependencies` (`0` by default)!

## Step 6: Manage package archives
## 🔍 Step 6: Manage package archives

You can manage package archives by using the `source` directive in your **Eask**-file.

Expand All @@ -138,7 +140,7 @@ You can manage package archives by using the `source` directive in your **Eask**
💡 See [DSL/source](https://emacs-eask.github.io/DSL/#-source-alias) for more information!
{{< /hint >}}

## Step 7: Add some dependencies
## 🔍 Step 7: Add some dependencies

You can add dependencies by using `depends-on` directive in your **Eask**-file.

Expand All @@ -155,7 +157,7 @@ You can add dependencies by using `depends-on` directive in your **Eask**-file.
Or else you would get an error **`package-name-' is unavailable**!
{{< /hint >}}

## Step 8: Install dependencies
## 🔍 Step 8: Install dependencies

Now we can install the dependencies we have specified in the **Eask**-file:

Expand All @@ -174,7 +176,7 @@ Installing 2 package dependencies...
(Total of 2 dependencies installed, 0 skipped)
```

## See Also
## 🔗 See Also

- [Commands and options](https://emacs-eask.github.io/Getting-Started/Commands-and-options/)
- [Domain Specific Language](https://emacs-eask.github.io/DSL/)
Expand Down
25 changes: 13 additions & 12 deletions docs/content/Getting-Started/Quick-Start/_index.zh-tw.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@ weight: 100
使用 Eask 作為您的 Emacs 包管理工具。

{{< hint info >}}
安裝是跨平台的,使用 [npm](https://www.npmjs.com/)。 關於如何使用其他方法安裝 Eask 的說明,
請參見[安裝](https://emacs-eask.github.io/Getting-Started/Install-Eask/)
安裝是跨平台的,並使用 [npm](https://www.npmjs.com/)
有關使用其他方法安裝 Eask 的說明,請參閱
[安裝](https://emacs-eask.github.io/Getting-Started/Install-Eask/)部分。

需要安裝 [Git](https://git-scm.com/downloads) 才能運行本教程。
{{< /hint >}}

## 步驟 1: 設置 NodeJS runtime 和 `npm`
## 🔍 步驟 1: 設置 NodeJS runtime 和 `npm`

請在 [此處](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm#using-a-node-installer-to-install-nodejs-and- npm)
並安裝 `NodeJS``npm` 對應你當前的操作系統
Expand All @@ -24,19 +25,19 @@ weight: 100
來自我們的 [release](https://github.com/emacs-eask/cli/releases) 頁面。
{{< /hint >}}

## 步驟 2: 安裝 Eask
## 🔍 步驟 2: 安裝 Eask

```sh
$ npm install -g @emacs-eask/cli
```

要驗證您的新安裝
驗證您的新安裝

```sh
$ eask --version
```

## 步驟 3: 導航到現有項目或創建新項目
## 🔍 步驟 3: 導航到現有項目或創建新項目

如果您已有一個現有的 elisp 項目,請導航到項目根文件夾。

Expand All @@ -52,7 +53,7 @@ $ eask create package project-name

它應該在您當前的工作目錄中創建一個名為 `project-name` 的文件夾。

## 步驟 4: 創建 `Eask` 文件
## 🔍 步驟 4: 創建 `Eask` 文件

如果您選擇使用 **`eask create`** 創建項目,請跳過此步驟!

Expand Down Expand Up @@ -95,7 +96,7 @@ Is this OK? (yes) yes ⏎

您應該能夠在項目文件夾中看到一個 `Eask` 文件。 🎉🎊

## 步驟 5: 開始包開發
## 🔍 步驟 5: 開始包開發

要檢查您的包裹信息,請運行:

Expand All @@ -122,7 +123,7 @@ dist

從一開始,您就不會有任何 `dependencies``devDependencies`(默認為 `0`)!

## 步驟 6: 管理包檔案
## 🔍 步驟 6: 管理包檔案

您可以使用 **Eask** 文件中的 `source` 指令來管理包存檔。

Expand All @@ -135,7 +136,7 @@ dist
💡 有關更多信息,請參閱 [DSL/source](https://emacs-eask.github.io/DSL/#-source-alias)
{{< /hint >}}

## 步驟 7: 添加一些依賴
## 🔍 步驟 7: 添加一些依賴

您可以在 **Eask** 文件中使用 `depends-on` 指令添加依賴項。

Expand All @@ -152,7 +153,7 @@ dist
否則你會得到一個錯誤 **`package-name-' is unavailable**
{{< /hint >}}

## 步驟 8: 安裝依賴
## 🔍 步驟 8: 安裝依賴

現在我們可以安裝我們在 **Eask** 文件中指定的依賴項:

Expand All @@ -171,7 +172,7 @@ Installing 2 package dependencies...
(Total of 2 dependencies installed, 0 skipped)
```

## 也可以看看
## 🔗 也可以看看

- [Commands and options](https://emacs-eask.github.io/Getting-Started/Commands-and-options/)
- [Domain Specific Language](https://emacs-eask.github.io/DSL/)
Expand Down

0 comments on commit d25e70b

Please sign in to comment.