Skip to content

Commit f4e6119

Browse files
committed
refactor: typedoc frontmatter
1 parent c3ddeb7 commit f4e6119

File tree

8 files changed

+39
-9
lines changed

8 files changed

+39
-9
lines changed

docs/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: Overview
3+
group: Documents
4+
category: Guides
5+
children:
6+
- ./usage/usage.md
7+
---
18
# H5P-Nodejs-library
29

310
[![CircleCI](https://circleci.com/gh/Lumieducation/H5P-Nodejs-library/tree/master.svg?style=svg)](https://circleci.com/gh/Lumieducation/H5P-Nodejs-library/tree/master) [![Coverage Status](https://coveralls.io/repos/github/Lumieducation/H5P-Nodejs-library/badge.svg?branch=release)](https://coveralls.io/github/Lumieducation/H5P-Nodejs-library?branch=release)

docs/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
- [Basic usage](usage/usage.md)
44
- [Architecture](usage/architecture.md)
55
- [Integrating the core library](usage/integrating.md)
6-
- [H5P Ajax Endpoints](usage/ajax-endpoints.md)
6+
- [Handling Ajax requests](usage/ajax-endpoints.md)
77
- [Constructing H5PEditor](usage/h5p-editor-constructor.md)
88
- [REST Example](examples/rest/README.md)
99
- Advanced usage

docs/usage/ajax-endpoints.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Handling AJAX requests
3+
group: Documents
4+
category: Guides
5+
---
16
# Handling AJAX requests
27

38
There are two ways of handling AJAX requests: You can use the out-of-the-box

docs/usage/architecture.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Architecture
3+
group: Documents
4+
category: Guides
5+
---
16
# Architecture
27

38
## General overview

docs/usage/h5p-editor-constructor.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Constructing H5PEditor
3+
group: Documents
4+
category: Guides
5+
---
16
# Constructing a H5PEditor object
27

38
There are two ways of creating a H5PEditor object:

docs/usage/integrating.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Integrating the core library
3+
group: Documents
4+
category: Guides
5+
---
16
# Using @lumieducation/h5p-server to create your own H5P server application
27

38
## Installation

docs/usage/usage.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
---
2+
title: Usage
3+
group: Documents
4+
category: Guides
5+
children:
6+
- ./architecture.md
7+
- ./integrating.md
8+
- ./ajax-endpoints.md
9+
- ./h5p-editor-constructor.md
10+
- ../examples/rest/README.md
11+
---
112
# Basic usage
213

314
To find out what this library provides for you and what you must implement on

typedoc.json

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,6 @@
22
"entryPointStrategy": "packages",
33
"entryPoints": [
44
"packages/h5p-clamav-scanner",
5-
"packages/h5p-express",
6-
"packages/h5p-html-exporter",
7-
"packages/h5p-mongos3",
8-
"packages/h5p-react",
9-
"packages/h5p-redis-lock",
10-
"packages/h5p-server",
11-
"packages/h5p-shared-state-server",
12-
"packages/h5p-svg-sanitizer",
135
"packages/h5p-webcomponents"
146
],
157
"projectDocuments": ["docs/README.md"],

0 commit comments

Comments
 (0)