adapt-authoring-core 1.3.2 → 1.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/adapt-authoring.json +1 -0
- package/docs/cover-manual.md +11 -0
- package/docs/index-manual.md +37 -7
- package/package.json +1 -1
package/adapt-authoring.json
CHANGED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
# Adapt authoring tool
|
|
4
|
+
|
|
5
|
+
## Developer guides
|
|
6
|
+
|
|
7
|
+
> Handy guides and how-to information to help understand and make use of the Adapt authoring tool APIs in a practical way.
|
|
8
|
+
|
|
9
|
+
[<i class="material-icons">download</i> Install](install)
|
|
10
|
+
[<i class="material-icons">settings</i> Configure](configuration)
|
|
11
|
+
[<i class="material-icons">flight_takeoff</i> Run](run)
|
package/docs/index-manual.md
CHANGED
|
@@ -1,11 +1,41 @@
|
|
|
1
|
-
|
|
1
|
+
# Adapt Authoring Tool Developer guides
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Welcome to the technical documentation for the Adapt authoring tool — a web-based application for creating responsive, multi-device e-learning content built on the [Adapt Framework](https://github.com/adaptlearning/adapt_framework).
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
The authoring tool provides a user-friendly interface for building courses without needing to write code, while its modular architecture gives developers the flexibility to extend and customise virtually every aspect of the system. Whether you're looking to build custom plugins, integrate with external services, or contribute to the core codebase, you're in the right place.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
## What makes it tick
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
9
|
+
The authoring tool is built on a few key principles:
|
|
10
|
+
|
|
11
|
+
- **Modular by design** — The entire application is composed of discrete modules that can be swapped, extended, or replaced. Need custom authentication? Write an auth plugin. Want to store data differently? Create a new database adapter.
|
|
12
|
+
|
|
13
|
+
- **Schema-driven** — Content types, validation rules, and UI forms are all defined using JSON schemas. This means you can add new content types or modify existing ones without touching application code.
|
|
14
|
+
|
|
15
|
+
- **RESTful API** — Every feature is accessible via a comprehensive REST API, making it straightforward to integrate with other systems or build custom tooling.
|
|
16
|
+
|
|
17
|
+
- **Built for collaboration** — Multi-user support with role-based permissions lets teams work together on courses with appropriate access controls.
|
|
18
|
+
|
|
19
|
+
## About this documentation
|
|
20
|
+
|
|
21
|
+
This documentation covers the technical side of the authoring tool — how it works under the hood and how to extend it. You'll find guides on writing custom modules, working with the database, creating schemas, and contributing to the project.
|
|
22
|
+
|
|
23
|
+
If you're looking for help using the authoring tool to create courses, check out the user guides on the [Adapt Learning community site](https://www.adaptlearning.org/).
|
|
24
|
+
|
|
25
|
+
## Where to start
|
|
26
|
+
|
|
27
|
+
New to the codebase? Here are some good starting points:
|
|
28
|
+
|
|
29
|
+
- **[Folder Structure](folder-structure)** — Get familiar with how the application is organised
|
|
30
|
+
- **[Writing a Module](writing-a-module)** — Learn the basics of creating your own module
|
|
31
|
+
- **[Schemas Introduction](schemas-introduction)** — Understand how schemas drive the application
|
|
32
|
+
- **[Hooks](hooks)** — See how to tap into the application lifecycle
|
|
33
|
+
|
|
34
|
+
## Get involved
|
|
35
|
+
|
|
36
|
+
The Adapt authoring tool is open source and we welcome contributions. You can find the source code and report issues on GitHub:
|
|
37
|
+
|
|
38
|
+
- [adapt-security](https://github.com/adapt-security) — Authoring tool repositories
|
|
39
|
+
- [adaptlearning](https://github.com/adaptlearning) — Adapt Framework and community plugins
|
|
40
|
+
|
|
41
|
+
<div class="big-text">Happy coding!</div>
|