diff --git a/README.md b/README.md index 41d78e4..d73fdc6 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ This repository is managed as a monorepo, using Lerna. Each package in this repo - `oslo-generator-jsonld-context` generates a JSON-LD context file using an OSLO JSON-LD as input - `oslo-generator-rdf-vocabulary` generates an RDF file using an OSLO JSON-LD as input - `oslo-generator-respec-html` generates an HTML page using the ReSpec template using an OSLO JSON-LD as input +- `oslo-generator-html` generates an HTML page using the Nunjucks template using an OSLO JSON-LD as input The packages `oslo-core` and `oslo-extractor-uml-ea` are not executable via the CLI, as their purpose is to be added as a depedency in other packages. diff --git a/packages/oslo-generator-html/REAMDE.md b/packages/oslo-generator-html/REAMDE.md new file mode 100644 index 0000000..43a92f0 --- /dev/null +++ b/packages/oslo-generator-html/REAMDE.md @@ -0,0 +1,25 @@ +# `OSLO HTML Generator` + +> Given an OSLO-compliant RDF file, this tool generates an HTML file with the HTML layout + +## Install + +``` +npm install @oslo-flanders/html-generator +``` + +## Global install + +To use the service from the command line anywhere, you can install it globally. + +```bash +npm install -g @oslo-flanders/html-generator +``` + +## API + +## Usage + +```bash + +``` diff --git a/packages/oslo-generator-html/package.json b/packages/oslo-generator-html/package.json new file mode 100644 index 0000000..f78d3d4 --- /dev/null +++ b/packages/oslo-generator-html/package.json @@ -0,0 +1,50 @@ +{ + "name": "@oslo-flanders/html-generator", + "version": "0.0.1-alpha.0", + "description": "Generates an HTML file using an OSLO-compliant RDF file", + "author": "Digitaal Vlaanderen ", + "homepage": "https://github.com/informatievlaanderen/OSLO-UML-Transformer/tree/main/packages/oslo-generator-html#readme", + "license": "MIT", + "main": "index.js", + "bin": { + "oslo-generator-respec": "./bin/runner.js" + }, + "directories": { + "lib": "lib", + "bin": "bin" + }, + "files": [ + "lib/**/*.d.ts", + "lib/**/*.js", + "lib/**/*.njk", + "bin/**/*.d.ts", + "bin/**/*.js", + "index.d.ts", + "index.js" + ], + "repository": { + "type": "git", + "url": "git+https://github.com/Informatievlaanderen/OSLO-UML-Transformer.git" + }, + "scripts": { + "build": "npm run build:ts", + "build:ts": "tsc" + }, + "bugs": { + "url": "https://github.com/Informatievlaanderen/OSLO-UML-Transformer/issues" + }, + "dependencies": { + "@oslo-flanders/core": "^0.0.14-alpha.0", + "inversify": "^6.0.1", + "n3": "^1.16.4", + "nunjucks": "^3.2.4", + "reflect-metadata": "^0.1.13", + "yargs": "^17.7.2" + }, + "devDependencies": { + "@rdfjs/types": "^1.1.0", + "@types/nunjucks": "^3.2.2" + }, + "gitHead": "b8a15c4c91863a99770fcd716ca0ba1ead9bd85c" + } + \ No newline at end of file