This repository was archived by the owner on Nov 26, 2017. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathexample.md.html
122 lines (83 loc) · 3.84 KB
/
example.md.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
**Example page!**
This is example page of [markdeep-docs-style](https://github.com/aras-p/markdeep-docs-style),
with content that could be an imaginary documentation
page. Here would be some introduction text, perhaps with links, e.g.
to [Markdeep](https://casual-effects.com/markdeep/) itself. Or how about a link
to the [source of this very page](https://github.com/aras-p/markdeep-docs-style/blob/master/example.md.html).
## What is this?
**Thing** is a thing used to do stuff for various platforms. Some of the things it can do:
* Run on a computer
* Exit with an exit code
* Be a replacement for our old system, `theoldthing.exe`
## Invoking it
<div class="note">
This is a note by the way!
</div>
From the root folder, run "thing" with the target name, e.g.: `thing Yes`
* On Mac, Linux or Windows PowerShell, you'll want to use `./thing` instead of just `thing`.
* Target and option names are case sensitive!
* Several things to do can be specified: `thing Yes No FileNotFound`
Additional options can be passed via `-sNAME=VALUE` arguments. Most common ones are CONFIG
(used to indicate debug or release thing) and PLATFORM (used to indicate 32 vs 64 bit thing).
### Subsection on stuff
Thing Name | Description |Notes
------------------------|--------------------|-----
Yes | Yup! |
No | Nope :( |
FileNotFound | Doesn't find files | Pass `-sFIND_FILE=maybe` to maybe find them
## Markdeep syntax test
Regular styling like **bold**, _italics_, ~~strikethrough~~, `inline code`, the stuff.
* A
* Bullet
* List
And:
1. A
1. Numbered
1. List!
Symbol substitutions: a 45-degree turn; som x -> y arrows; some whoa ==> fancy <==> arrows.
Is this a definition list?
: Looks like one to me
Is that right?
: Possibly!
And a code listing:
```
int main()
{
return 1;
}
```
Markdeep diagrams:
******************************************* Here's a text to the right of the diagram,
* +-----------------+ .-. * ain't that fancy. Pretty fancy indeed, I
* |\ | .-+ | * must say! Markdeep diagrams are generally
* | \ A-B *---+--> .--+ '--. * enclosed into a rectangle full made of `*`
* | \ | | Cloud! | * symbols; and are "drawn" using ASCII-art
* +---+-------------+ '-------------' * style, with `- | + / \ * o` etc.
******************************************* Suh-weet!
Another random diagram, just because:
********************
* +-+-+-+-*-o *
* / / ^ / *
* / v / / *
* +-+-+-+ *
********************
Now, the following are not part of Markdeep per se, but something in spirit of
[Admonition](https://squidfunk.github.io/mkdocs-material/extensions/admonition/) blocks.
Would be lovely if Markdeep would support Admonition-like `!!! type` syntax for them.
For now their styles are just in my CSS file, and in the source they contain literal
`<div class="note">` and `</div>` around the text:
<div class="note">
Hey I'm a note. Don't mind me, I'm just sitting here.
</div>
<div class="warn">
I'm a warning, perhaps. *Something might happen!*
</div>
<div class="error">
Watch out, something **bad**?
</div>
The table of contents that Markdeep produces is stuffed on the right side,
if the browser window is wide enough. Otherwise it is hidden.
Well, that's about it! Below all this is just a style statement to make
the CSS kick in: `<link rel="stylesheet" href="markdeep-docs.css">`, followed
by the regular markdeep magic line.
<link rel="stylesheet" href="markdeep-docs.css"><!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="https://casual-effects.com/markdeep/0.22/markdeep.min.js"></script></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>