{"id":23009921,"url":"https://github.com/openactive/extension-documentation-generator","last_synced_at":"2025-04-02T16:14:46.252Z","repository":{"id":54226021,"uuid":"149575052","full_name":"openactive/extension-documentation-generator","owner":"openactive","description":"Generate documentation for OpenActive extensions","archived":false,"fork":false,"pushed_at":"2022-08-18T19:29:32.000Z","size":41,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-02-08T07:08:32.166Z","etag":null,"topics":["extensions","specifications"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openactive.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-09-20T08:14:31.000Z","updated_at":"2021-03-02T13:07:54.000Z","dependencies_parsed_at":"2022-08-13T09:40:18.564Z","dependency_job_id":null,"html_url":"https://github.com/openactive/extension-documentation-generator","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openactive%2Fextension-documentation-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openactive%2Fextension-documentation-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openactive%2Fextension-documentation-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openactive%2Fextension-documentation-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openactive","download_url":"https://codeload.github.com/openactive/extension-documentation-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246847137,"owners_count":20843444,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["extensions","specifications"],"created_at":"2024-12-15T09:16:32.265Z","updated_at":"2025-04-02T16:14:46.220Z","avatar_url":"https://github.com/openactive.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# extension-documentation-generator\nGenerates documentation for OpenActive vocabulary extensions\n\nThis GitHub Action generates an index.md file from a JSON-LD extension context, useful for serving OpenActive vocabulary extension documentation via GitHub Pages.\n\n## Usage\n\nCreate 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.\n\n```yml\nname: Deploy to GitHub Pages\n\non:\n  push:\n    branches:\n      - master\n\njobs:\n  deploy:\n    runs-on: ubuntu-18.04\n    steps:\n      - uses: actions/checkout@v2\n      - name: Render Documentation\n        uses: openactive/extension-documentation-generator@master\n        with:\n          header: header.md\n          context: {prefix}.jsonld\n          with_issues: false\n      - name: Deploy\n        uses: peaceiris/actions-gh-pages@v3\n        with:\n          github_token: ${{ secrets.GITHUB_TOKEN }}\n          publish_dir: ./out\n          force_orphan: true\n          enable_jekyll: true\n```\n\nYou may customise three parameters:\n1) `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`.\n2) `header` - markdown file to prepended to the generated documentation, e.g. `header.md`\n3) `with_issues` - whether to include GitHub issues from the context in the generated documentation\n\n## Examples\n\nThe following repositories make use of this GitHub Action:\n- https://github.com/openactive/ns-beta\n- https://github.com/openactive/test-interface\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenactive%2Fextension-documentation-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenactive%2Fextension-documentation-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenactive%2Fextension-documentation-generator/lists"}