CzompiSoftware / CzompiSoftware/CwATE-MA

Develop Comprehensive Documentation for XMDL Language

Open
#13 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
C#
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

To facilitate the effective adoption and utilization of the XMDL language within the CwATE-MA system, it is essential to create detailed and user-friendly documentation. This documentation should encompass all aspects of XMDL, providing clear guidance for developers and users.

**Tasks:**

1. **Overview of XMDL:**
- Provide a comprehensive introduction to XMDL, outlining its purpose, key features, and advantages over standard Markdown.

2. **Syntax and Structure:**
- Detail the syntax rules of XMDL, including:
- **Standard Markdown Elements:**
- Headers, lists, links, images, etc.
- **Extended Features:**
- **Lua Integration:**
- Multi-line Lua code blocks:
```xmdl
@lua{>
-- Lua code here
<}
```
- Inline Lua code:
```xmdl
@lua{# -- Lua code here #}
```
- **Alert Blocks:**
- Syntax:
```xmdl
]>block level, e.g., warning< # Markdown elements can be included here
] This is also part of *this* block
```

3. **Usage Examples:**
- Provide practical examples demonstrating the application of XMDL features in real-world scenarios.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.