OSLO Markdown Generator

Given an OSLO-compliant RDF file, this tool generates a markdown file that describes classes and relevant properties, to be used in the Metadata Vlaanderen documentation.

Install

npm install @oslo-flanders/markdown-generator

Global install

To use the service from the command line anywhere, you can install it globally.

npm install -g @oslo-flanders/markdown-generator

API

The service is executed from the CLI and expects the following parameters: | Parameter | Description | Required | Possible values | | ------------ | ------------------------------------------------------------- | ------------------ | --------------------------- | | --input | The URL or local file path of an OSLO-compliant RDF file | :heavy_check_mark: | | | --output | The name of the output directory to store output files in | No | | | --language | The language in which the markdown must be generated (labels) | No | | | --baseURI | The baseURI used to generate profile-specific information | No | | | --silent | Suppress log messages | No | true or false (default) |

Usage

Using the published package.

oslo-generator-markdown --input dcatapvl.20220421.jsonld --output output --language nl

Using a development environment.

npm run build
./bin/runner.js --input dcatapvl.20220421.jsonld

For input, use the intermediary OSLO format. Some examples:

• DCAT-AP-VL 2022-04-21
• Metadata-DCAT 2022-04-21
• DCAT-AP-VL 2026-02-24