gufo2html
TypeScript icon, indicating that this package has built-in type declarations

0.0.1-alpha.0 • Public • Published

gUFO to HTML

GitHub Workflow Status

Javascript library utility for transform gUFO files to HTML.

Getting Start

npm install gufo2html --save

// yarn users
yarn add gufo2html

Usage

import { transformGUFO2HTML } from 'gufo2html';

transformGUFO2HTML(ttlStringModel, options)

Options

baseIRI?: string;
documentationProps?: {
  title?: string;
  description?: string[];
  customPartials?: {
    headContent?: string;
    styles?: string;
    head?: string;
    body?: string;
    generalInformation?: string;
    termsIndex?: string;
    classes?: string;
    relations?: string;
    attributes?: string;
  };
  theme?: DocTheme;
};
format?: string;

Theme

colors?: {
  background?: string;
  border?: string;
  title?: string;
  text?: string;
};
shape?: {
  borderRadius?: string;
};
typography?: {
  fontFamily?: string;
  fontSize?: string;
  mobileFontSize?: string;
};
overrides?: {
  [key in keyof HTMLElementTagNameMap]?: CSS.Properties;
};

About

If you are interested to know more, feel free to open an issue to provide feedback on the project or reach our team members for more specific cases:

Readme

Keywords

none

Package Sidebar

Install

npm i gufo2html

Weekly Downloads

0

Version

0.0.1-alpha.0

License

Apache-2.0

Unpacked Size

98.6 kB

Total Files

22

Last publish

Collaborators

  • lucasbassetti