Как использовать документацию Slate с оболочкой Bash?

Question

[отредактировано, чтобы попытаться задать вопрос лучше]:

Я строю небольшой проект с Bash, который в основном API. Я думал, что попробую Slate. Однако, хотя кажется, что Slate поддерживает bash, я просто не понимаю, как должен создаваться синтаксис.

Я пытаюсь выяснить, какие правильные аннотации кода требуются (синтаксис) для подачи на сланец для создания правильной записи документации (для bash)

Любая помощь будет оценена.

Вот, возможно, лучшее описание того, что я ожидаю в качестве ввода и вывода:

Ожидаемый ввод из исходного файла:

pud() {
    # pud():
    # * Description: similar to pushd.
    # * Arguments:
    #   * $1:
    #       * [directory]: adds directory if provided
    #       * default: `CWD`
    ## TODO:
    # * check for / parse argument
    # * check for popd error
    ## Notes:
    # * pushd -N/+N not honored (use pushd for that)
    # * pushd -n is the same as `pud [dir]`

    # pushd `cwd`
    pushd . >/dev/null

    # update the project file
    dirp_saveProject "$DIRP_THIS_PROJECT" true
}

Я ожидаю, что вывод будет переведен в HTML-версию следующей разметки:

# pud():
* Description: function similar to pushd.
* Arguments:
  * $1:
      * [directory]: adds directory if provided
      * default: `CWD`

## TODO:
* check for / parse arguments
* check for / parse popd error

## Notes:
* pushd -N/+N not honored (use pushd for that)
* pushd -n is the same as `pod [dir]`

```shell
pud() {
    # pushd `cwd`
    pushd . >/dev/null

    # update the project file
    dirp_saveProject "$DIRP_THIS_PROJECT" true
}
```

Таким образом, вывод html будет похож на (этот пример сгенерирован pandoc, но я надеюсь, что вы поняли идею):

пуд ():

• Описание: функция, аналогичная pushd.
• Аргументы:
  • $ 1:
    • [каталог]: добавляет каталог, если предоставляется
    • дефолт: CWD

СДЕЛАТЬ:

• проверить / проанализировать аргументы
• проверить / parse на ошибку popd

Заметки:

• pushd -N / + N не соблюдается (для этого используйте pushd)
• push-n такой же, как pud [dir]

pud () {

# pushd cwd

пуш. >/ DEV / нуль

# обновить файл проекта

dirp_saveProject "$ DIRP_THIS_PROJECT" true

}