https://github.com/athackst/mkdocs-action-yml

A markdown extension for mkdocs to document action.yml files
https://github.com/athackst/mkdocs-action-yml

Last synced: about 1 year ago
JSON representation

A markdown extension for mkdocs to document action.yml files

• Host: GitHub
• URL: https://github.com/athackst/mkdocs-action-yml
• Owner: athackst
• License: apache-2.0
• Created: 2023-09-16T23:17:54.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-09-18T23:52:32.000Z (over 2 years ago)
• Last Synced: 2025-02-10T12:33:15.616Z (over 1 year ago)
• Language: Python
• Size: 16.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# mkdocs-action-yml

A markdown extension for mkdocs to document action.yml files

## Reference

### Block syntax

The syntax for a `mkdocs-action-yml` block is the following:

```md

::: mkdocs-action-yml

    :path: action.yml

    :owner: organization or user

    :version: v0.0.1

```

Options:

    - `path`: [required] Path to the action.yml file

    - `owner`: [required] Owner of the action file (to locate the action)

    - `version`: [optional] The latest version of the action