UNPKG

@argdown/node

Version:

Async Argdown application for node.js

christianvoigt/argdown

7 lines (4 loc) • 1 kB
1
2
3
4
5
6
7
# @argdown/node This is the documentation of the [[`@argdown/node` package]](https://github.com/christianvoigt/argdown/blob/master/packages/argdown-node/README.md). `@argdown/node` enhances the `@argdown/core` package of the [Argdown project](https://christianvoigt.github.io/argdown) with node specific features, like file loading and saving plugins and an asynchronous extension of the `ArgdownApplication` class. It also provides an instance of this class that loads all plugins into processors. This instance is used as the basis for the VS Code extension (`@argdown/vscode`) and the commandline tool (`@argdown/cli`). If you want to familiarize yourself with the code, start with reading the documentation for [[AsyncArgdownApplication]] and [[IAsyncArgdownPlugin]] and read the `argdown.ts` file in the repository. For further information on the structure of the application and the plugins, see the `@argdown/core` [documentation](https://christianvoigt.github.com/argdown/argdown-core/).