moth/example-puzzles/example/1/puzzle.md

1.3 KiB

authors debug answers
neale
summary
static puzzles
puzzle.md

Puzzle categories are laid out on the filesystem:

example/
├─1
│  └─puzzle.md
├─2
│  ├─puzzle.md
│  └─salad.jpg
├─3
│  └─mkpuzzle
├─10
│  └─puzzle.md
└─100
   └─mkpuzzle

In this example, there are puzzles with point values 1, 2, 3, 10, and 100.

Puzzles 1, 2, and 10 are "static" puzzles: their content was written by hand.

Puzzles 3 and 100 are "dynamic" puzzles: their content is generated by mkpuzzle.

To create a static puzzle, all you must have is a puzzle.md file in the puzzle's directory. This file is in the following format:

---
pre:
  authors:
    - name of the person who wrote this puzzle
debug:
  summary: brief description of the puzzle
answers: 
  - answer to this puzzle
  - second acceptable answer to this puzzle
---
This is the puzzle body.
It is Markdown formatted:
you can read more about Markdown on the Internet.

To move to the next puzzle in a category, someone on some team must provide an answer to the highest-point puzzle in that category.

The answer to this puzzle is the name of the file required to make a static puzzle.