# Documentation for nmk-github plugin

This plugin adds support for Github features in an **`nmk`** project:
* [Github workflow file](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions) generation
* README badges generation (if [**`nmk-badges`**](https://github.com/dynod/nmk-badges) plugin is also used):
  * link to license
  * build action status
  * opened issues

```{toctree}
:caption: 'Contents'
:maxdepth: 2
usage
tasks
extend
config
contribs
changelog
```

## Indices and tables

- {ref}`genindex`
- {ref}`modindex`
- {ref}`search`