Skip to content

Commit b3e1df8

Browse files
committed
Clean up doc README
1 parent 7d7c2f5 commit b3e1df8

File tree

1 file changed

+8
-20
lines changed

1 file changed

+8
-20
lines changed

docs/README.md

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,12 @@
1-
---
2-
title: README_docs
3-
layout: none
4-
---
1+
# API documentation for CAI Node.js library
52

6-
**@contentauth/c2pa-node**
3+
The files in these directories are generated by TypeDoc (except for `index.md`). Do not edit them:
74

8-
# @contentauth/c2pa-node
5+
- `classes`
6+
- `functions`
7+
- `interfaces`
8+
- `type-aliases`
99

10-
## [Classes](classes/index.md)
10+
All the other files under `/docs` are used to scaffold the Jekyll site.
1111

12-
{% include_relative classes/index.md %}
13-
14-
## [Interfaces](interfaces/index.md)
15-
16-
{% include_relative interfaces/index.md %}
17-
18-
## [Type Aliases](type-aliases/index.md)
19-
20-
{% include_relative type-aliases/index.md %}
21-
22-
## [Functions](functions/index.md)
23-
24-
{% include_relative functions/index.md %}
12+
The `publish-docs.yml` workflow runs TypeDoc, runs Jekyll, and publishes the resulting HTML using GitHub Pages.

0 commit comments

Comments
 (0)