Skip to content

Commit 5bcc737

Browse files
sr258sr258
committed
refactor: added frontmatter to all docs
1 parent f4e6119 commit 5bcc737

23 files changed

+139
-6
lines changed

‎docs/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
title: Overview
33
group: Documents
44
category: Guides
5-
children:
6-
- ./usage/usage.md
75
---
86
# H5P-Nodejs-library
97

‎docs/advanced/addons.md

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

38
Addons are H5P libraries that can be added to the H5P Editor or to certain H5P

‎docs/advanced/advanced.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Advanced usage
3+
group: Documents
4+
category: Guides
5+
children:
6+
- ./authorization.md
7+
- ./user-content-state.md
8+
- ./context-ids.md
9+
- ./impersonation.md
10+
- ./completion-tracking.md
11+
- ./localization.md
12+
- ./cluster.md
13+
- ./addons.md
14+
- ./customization.md
15+
- ./performance-optimizations.md
16+
- ./privacy.md
17+
- ./proxy.md
18+
- ./security.md
19+
---
20+
# Advanced aspects of using @lumieducation packages

‎docs/advanced/authorization.md

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

38
Many actions users perform in the H5P system need authorization. By default the

‎docs/advanced/cluster.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Running in a cluster
3+
group: Documents
4+
category: Advice
5+
---
16
# Running the example in cluster mode
27

38
The example can (mostly) be run in cluster mode to scale h5p horizontally.

‎docs/advanced/completion-tracking.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
# Completion tracking
1+
---
2+
title: Basic Completion tracking
3+
group: Documents
4+
category: Features
5+
---
6+
# Basic completion tracking
27

38
The H5P client is capable of sending a message to the server when the user has
49
completed a content object. This includes the time when this occured, how long

‎docs/advanced/context-ids.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Multiple user states per object
3+
group: Documents
4+
category: Features
5+
---
16
# Multiple content states per object
27

38
You can save multiple user states (= the data a learner entered, e.g. the

‎docs/advanced/customization.md

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

38
An application using @lumieducation/h5p-server can customize the way H5P behaves in

‎docs/advanced/impersonation.md

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

38
It is possible to impersonate users when viewing a H5P object. This means that

‎docs/advanced/localization.md

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

38
## Localizing the player

0 commit comments

Comments
 (0)