diff options
author | Jo-Philipp Wich <jo@mein.io> | 2023-05-31 13:28:14 +0200 |
---|---|---|
committer | Jo-Philipp Wich <jo@mein.io> | 2023-07-12 10:45:21 +0200 |
commit | 70f93488b93e8baa5b090d427019e70da933eb33 (patch) | |
tree | 7c4b10cd827fdb51e457c3aaba3b0ede0c62d42b /docs/README.md | |
parent | e06f656f5043d5b86f6ccfb7f9b8447800623659 (diff) |
docs: add initial JSDoc infrastructure
Introduce the infrastructure for building ucode module documentation using
JSDoc annotations.
To build the documentation, run `npm install` followed by `npm run doc`.
Signed-off-by: Jo-Philipp Wich <jo@mein.io>
Diffstat (limited to 'docs/README.md')
-rw-r--r-- | docs/README.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..17fffbe --- /dev/null +++ b/docs/README.md @@ -0,0 +1,5 @@ +# ucode Documentation + +## Module Reference + + - [ucode module documentation](index.html) |