28 lines
783 B
Markdown
28 lines
783 B
Markdown
|
# Data format
|
||
|
|
||
|
This project uses markdown as its data storage format. The syntax used is important and wasn't chosen randomly.
|
||
|
|
||
|
## Syntax for examples
|
||
|
|
||
|
<!-- TOC BREAK -->
|
||
|
<!-- The TOC script likes to think headers in code blocks are things it should index -->
|
||
|
|
||
|
~~~markdown
|
||
|
<!-- ExampleName must not contain spaces or special characters and has to begin with a capital letter -->
|
||
|
- `ExampleName`: A comment
|
||
|
```markdown <!-- a language can be added to enable syntax highlighting -->
|
||
|
Data here
|
||
|
```
|
||
|
~~~
|
||
|
|
||
|
Headers also matter from the method name is generated from the text in them, ie:
|
||
|
~~~markdown
|
||
|
# IRC
|
||
|
## PING
|
||
|
- `ExampleUsage`: Example usage of `PING`
|
||
|
```
|
||
|
PING :test
|
||
|
```
|
||
|
~~~
|
||
|
|
||
|
The path for the `Ping` example is `IrcPing`, so the whole function name for Go will be `IrcPingExampleUsage`.
|