https://github.com/openactive/extension-documentation-generator

Generate documentation for OpenActive extensions
https://github.com/openactive/extension-documentation-generator

extensions specifications

Last synced: about 1 year ago
JSON representation

Generate documentation for OpenActive extensions

• Host: GitHub
• URL: https://github.com/openactive/extension-documentation-generator
• Owner: openactive
• Created: 2018-09-20T08:14:31.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-08-18T19:29:32.000Z (almost 4 years ago)
• Last Synced: 2025-02-08T07:08:32.166Z (over 1 year ago)
• Topics: extensions, specifications
• Language: JavaScript
• Size: 40 KB
• Stars: 0
• Watchers: 7
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# extension-documentation-generator

Generates documentation for OpenActive vocabulary extensions

This GitHub Action generates an index.md file from a JSON-LD extension context, useful for serving OpenActive vocabulary extension documentation via GitHub Pages.

## Usage

Create a new GitHub Action using the following template, in a repository that includes a `header.md` file and a `{prefix}.jsonld` context file in the root.

```yml

name: Deploy to GitHub Pages

on:

  push:

    branches:

      - master

jobs:

  deploy:

    runs-on: ubuntu-18.04

    steps:

      - uses: actions/checkout@v2

      - name: Render Documentation

        uses: openactive/extension-documentation-generator@master

        with:

          header: header.md

          context: {prefix}.jsonld

          with_issues: false

      - name: Deploy

        uses: peaceiris/actions-gh-pages@v3

        with:

          github_token: ${{ secrets.GITHUB_TOKEN }}

          publish_dir: ./out

          force_orphan: true

          enable_jekyll: true

```

You may customise three parameters:

1) `context` - jsonld context file used to generate the documentation. This should be named according to the prefix of your custom namespace, e.g. `beta.jsonld`.

2) `header` - markdown file to prepended to the generated documentation, e.g. `header.md`

3) `with_issues` - whether to include GitHub issues from the context in the generated documentation

## Examples

The following repositories make use of this GitHub Action:

- https://github.com/openactive/ns-beta

- https://github.com/openactive/test-interface