Действие GitHub, которое автоматически генерирует и обновляет контент Markdown (например, ваш readme.md) от внешних или удаленных файлов.

Почему markdown-autodocs?
Функции
Примеры
- Блок кода
- Json to. HTML таблица
- Таблица артефактов рабочего процесса GitHub
Пример репо, который использует все функцию Markdown-Autodocs
Локальное использование без действия GitHub
использование
- Добавление artdown-autodocs в вашем рабочем процессе
- Расширенный пример со всеми возможными вариантами, доступными для этого действия
Github Workflow Artifacts
Вклад
Использован
Лицензия

Почему markdown-autodocs

Чтобы сделать ваше репо более привлекательным и полезным, вам необходимо предоставить примерные фрагменты кода в вашем readme.md. Копировать и вручную копировать каждый фрагмент кода в их соответствующих местах в вашем readme будет неэффективным и трудоемким.

Эта проблема может быть решена с использованием Markdown-Autodocs Действие GitHub, которое автоматически генерирует и обновляет контент Markdown (например, ваш readme.md) от внешних или удаленных файлов. Вам нужно добавить маркеры в вашем readme.md, который скажет markdown-autodocs, где вставить фрагмент кода.

Функции

Блок кода: Вставьте фрагмент кода в файл разметки из внешних или удаленных файлов.
JSON в HTML Таблица: Вставьте таблицу HTML в файле разметки, конвертируя содержимое файла JSON в таблицу HTML.
Github Workflow Artifacts Таблица: Вставьте таблицу артефактов рабочего процесса GitHub в файле разметки, получая последние артефакты для запуска рабочего процесса.

Примеры

Блок кода

Получите код от внешнего файла или URL и вставьте его в свою установку.

Параметры:

Src. : Относительный путь к коду, чтобы потянуть, или URL где живет сырой код

JSON в таблицу HTML

Получите содержимое JSON из внешнего файла и преобразуйте его в таблицу HTML и вставьте его в свою установку.

Параметры:

Src. : Относительный путь к файлу JSON, чтобы потянуть.

Таблица артефактов рабочего процесса GitHub

Получите список последних артефактов, созданных из рабочего процесса. Создает таблицу артефактов рабочего процесса состоит из URL-адресов загрузки артефактов и рабочего процесса в HTML-таблице и вставляет его в файл разметки.

Пример репо, который использует все функцию Markdown-Autodocs

Локальное использование без действия GitHub

Установите Markdown-Autodocs CLI:

npm i -g markdown-autodocs

Использование CLI Markdown-autodocss:

dineshsonachalam@macbook ~ % markdown-autodocs --help
Usage: markdown-autodocs [options]

Options:
  -o, --outputFilePath   Output file paths
  -c, --category              code-block, json-to-html-table, workflow-artifact-table
  -r, --repo                           Repo name
  -b, --branch                         Branch name
  -a, --accessToken                    Github Access token
  -h, --help                                 display help for command

Блок кода

markdown-autodocs -c code-block -o ./README.md

JSON в таблицу HTML

markdown-autodocs -c json-to-html-table -o ./README.md

Таблица артефактов рабочего процесса GitHub

markdown-autodocs -c workflow-artifact-table -o ./README.md -r $REPO -b $BRANCH -a $ACCESSTOKEN

использование

Добавление artdown-autodocs в вашем рабочем процессе

Добавьте следующий шаг в конце работы, после других шагов, которые могут добавлять или изменять файлы.

uses: dineshsonachalam/markdown-autodocs@v1.0.3

Расширенный пример со всеми возможными вариантами, доступными для этого действия

- name: Markdown autodocs
- uses: dineshsonachalam/markdown-autodocs@v1.0.3
  with:
    # Optional, defaults to author of the commit that triggered the run
    commit_author: Author 

    # Optional, defaults to "actions@github.com"
    commit_user_email: actions@github.com

    # Optional, but recommended
    # Defaults to "Apply automatic changes"
    commit_message: Apply automatic changes

    # Optional branch name where commit should be pushed to.
    # Defaults to the current branch.
    branch: feature-123

    # Optional output file paths, defaults to '[./README.md]'.
    output_file_paths: '[./README.md]'

    # Categories to automatically sync or transform its contents in the markdown files.
    # Defaults to '[code-block,json-to-html-table,workflow-artifact-table]'
    categories: '[code-block,json-to-html-table,workflow-artifact-table]'

🚀 используется

Лицензия

Оригинал: “https://dev.to/dineshsonachalam/a-github-action-that-automatically-generates-updates-markdown-content-like-your-readme-md-from-external-or-remote-files-hp7”

Оглавление