Skip to content

Commit

Permalink
Link to API reference instead of using jsdoc2md
Browse files Browse the repository at this point in the history
  • Loading branch information
mdaines committed Oct 9, 2023
1 parent 5c29e7e commit 50be806
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 1,151 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ Other packages:
## Install

- Viz.js is published on NPM as [`@viz-js/viz`](https://www.npmjs.com/package/@viz-js/viz).
- lang-dot is published on NPM as [`@viz-js/lang-dot`](https://www.npmjs.com/package/@viz-js/lang-dot).

## API

See [the wiki](https://github.com/mdaines/viz-js/wiki/API).
[API Reference](https://viz-js.com/api/)
10 changes: 6 additions & 4 deletions packages/lang-dot/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# @viz-js/lang-dot
# lang-dot

[Graphviz DOT](https://www.graphviz.org/doc/info/lang.html) language support for the [CodeMirror](https://codemirror.net/) code editor.

# API
## Install

## `dot()`
lang-dot is published on NPM as [`@viz-js/lang-dot`](https://www.npmjs.com/package/@viz-js/lang-dot).

Returns a [LanguageSupport](https://codemirror.net/docs/ref/#language.LanguageSupport) instance for the Graphviz DOT language.
## API

[API Reference](https://viz-js.com/api/#lang-dot)
3 changes: 0 additions & 3 deletions packages/viz/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,5 @@ lib/module.mjs lib/module.wasm: src/module/Dockerfile src/module/viz.c src/modul
@test -f lib/module.mjs && touch lib/module.mjs
@test -f lib/module.wasm && touch lib/module.wasm

README.md: README.hbs src/*.mjs
yarn --silent jsdoc2md --configure ./jsdoc2md.json --template README.hbs --files src/*.mjs --no-gfm --heading-depth 3 --example-lang js > README.md

clean:
rm -f lib/module.mjs lib/module.wasm lib/encoded.mjs lib/metadata.mjs lib/viz-standalone.js lib/viz-standalone.mjs
39 changes: 0 additions & 39 deletions packages/viz/README.hbs

This file was deleted.

Loading

0 comments on commit 50be806

Please sign in to comment.