diff --git a/README.md b/README.md index 17ca327..3e0aac2 100644 --- a/README.md +++ b/README.md @@ -1 +1,70 @@ -A Github action to generate a markdown file into a Confluence page. \ No newline at end of file +A Github action to generate a markdown file into a Confluence page. + +This uses the tool in repo `https://github.com/kovetskiy/mark` + +The 'secret sauce' that makes it work are `md` tags **that github does not render** + +Here is the raw content for the Enterphone Hardware `hardware.md` - you can now see the meta + +``` + + + + + + + + + + + + + + + + + + +# Enterphone Hardware + +## Drawings +### Enterphone IQ +* [Back](./identiv_iQ_back.pdf) +* [Front](./identiv_iQ_front.pdf) +* [Inside](./Enterphone_IQ.pdf) +* Mounting: + * [PNG](./enterphone_iq_mounting.png) + * [SVG](./enterphone_iq_mounting.svg) + +### Enterphone 19" +* [Back](./identiv_mesh19_back.pdf) +* [Front](./identiv_mesh19_front.pdf) +* [Inside](./Enterphone_19.pdf) +* Mounting: + * [PNG](./enterphone_19_mounting.png) + * [SVG](./enterphone_19_mounting.svg) + +### Mounting + +* [Mounting Requirements](./Enterphone_Mounting_Requirements.pdf) -- see also above +``` + + +Example usage + +``` +jobs: + generate-confluence-page: + runs-on: ubuntu-latest + name: Generate Confluence pages + steps: + - name: Publish docs + uses: identiv/confluence@v1 + with: + source: '*.md' + url: https://identivegroup.atlassian.net/wiki + conf-account: 'your identiv email addr' + conf-api-key: ${{ secrets.CONFLUENCE_TOKEN }} +``` + +You can generate a `confluence_token` [here](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/)