neale/moth
neale
/
moth
mirror of https://github.com/dirtbags/moth.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Twiddle a bit

This commit is contained in:
Neale Pickett 2023-12-11 11:40:21 -07:00
parent bbb5a5484a
commit 3924eb0249
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/development.md
View File

@ -3,7 +3,8 @@ Developing Content: Structure
![Content Layout](content-layout.png)
MOTH content is structured ot two levels: categories, and puzzles.
MOTH content heirarchy consists of three layers:
categories, puzzles, and attachments.
Category
-------
@ -81,14 +82,23 @@ The body of a puzzle is interpreted as
[CommonMark Markdown](https://spec.commonmark.org/dingus/)
and rendered as HTML.
You can inline attached images with the `![alt text](filename.jpg)`
Markdown construct, but they must be listed as attachments!
### Attachments
Attachments
-------
Any filenames listed under `attachments` in the metadata will be included
with the puzzle.
Usually,
these are listed at the bottom of each puzzle,
one by one.
But you can also refer to attachments from the puzzle body
with either links or inline images.
```markdown
This is a [link](attachment-document.html).
And this is an inline image: ![alt text](attachment-image.png)
```
Developing Content: Source vs Mothballs
=============================