Skip to content

Commit

Permalink
docs: Add DSL
Browse files Browse the repository at this point in the history
  • Loading branch information
jcs090218 committed Nov 17, 2024
1 parent c166719 commit 41821b7
Show file tree
Hide file tree
Showing 2 changed files with 119 additions and 0 deletions.
60 changes: 60 additions & 0 deletions docs/content/DSL/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
title: Domain Specific Language
weight: 200
---

This document provides a reference on the [DSL](https://en.wikipedia.org/wiki/Domain-specific_language).

{{< toc >}}

# 🚩 Package contents

## 🔍 **files** (`&rest patterns`)

Specify list of files that are included in this project.

```cl
(files "foo.el")
(files "*.el" "core/*.el")
```

# 🚩 Tests

## 🔍 **script** (`name` `command` &rest `args`)

Add built-in scripts and their preset life cycle event as well as arbitrary
scripts.

```cl
(script "test" "echo This is a test!")
```

# 🚩 Dependencies

## 🔍 **source** (`alias`)

## 🔍 **source** (`name` `url`)

Add a system dist to install dependencies from.

```cl
(source "quicklisp")
(source "quicklisp" "http://beta.quicklisp.org/")
```

Available aliases:

- `quicklisp` (http://beta.quicklisp.org/)
- `ultralisp` (http://dist.ultralisp.org/)

## 🔍 **depends-on** (`&rest args`)

Specify a dependency for this system.

```elisp
(depends-on "fsdb" "https://github.com/billstclair/fsdb" :git)
```

{{< hint ok >}}
💡 Install dependencies with command **qob install-deps**!
{{< /hint >}}
59 changes: 59 additions & 0 deletions docs/content/DSL/_index.zh-tw.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: 领域特定语言
weight: 200
---

本文檔是關於 [DSL] (https://en.wikipedia.org/wiki/Domain-specific_language)。

{{< toc >}}

# 🚩 Package contents

## 🔍 **files** (`&rest patterns`)

指定包含在此專案中的檔案清單。

```cl
(files "foo.el")
(files "*.el" "core/*.el")
```

# 🚩 測試

## 🔍 **script** (`name` `command` &rest `args`)

新增內建指令碼及其預設生命週期事件,以及任意指令碼。

```cl
(script "test" "echo This is a test!")
```

# 🚩 依賴

## 🔍 **source** (`alias`)

## 🔍 **source** (`name` `url`)

新增一個系統 dist 來安裝相依性。

```cl
(source "quicklisp")
(source "quicklisp" "http://beta.quicklisp.org/")
```

可用別名:

- `quicklisp` (http://beta.quicklisp.org/)
- `ultralisp` (http://dist.ultralisp.org/)

## 🔍 **depends-on** (`&rest args`)

指定此系統的相依性。

```elisp
(depends-on "fsdb" "https://github.com/billstclair/fsdb" :git)
```

{{< hint ok >}}
💡 使用 **qob install-deps** 指令安裝相依性!
{{< /hint >}}

0 comments on commit 41821b7

Please sign in to comment.