This repository has been archived by the owner on Aug 2, 2020. It is now read-only.
forked from jem/jemdoc
-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy pathexample.jemdoc
executable file
·55 lines (38 loc) · 1.47 KB
/
example.jemdoc
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
# jemdoc: menu{MENU}{example.html}
= jemdoc -- example page
[https://jemnz.com/ Jacob Mattingley] ([[email protected]])
If the first line of the file starts with +\# jemdoc+, special functions like [menu.html menus] will be used.
== Example
Here are some *text* /features/. I could [http://cvxmod.net/ link somewhere] or insert a raw link to another page like [download.html]. I could use +monospace+, too.
I could write special characters like \#, \$ and \+ by just using a backslash (\\) in front of those characters. Or automatically detect an [[email protected] email address].
~~~
Save the file as +index.jemdoc+, say, and simply call +jemdoc index+ (after [download.html downloading jemdoc], of course).
~~~
== Next bit, next heading level two
=== Getting into level three now
Why not use a list
- to explain the way you do lists?
- to demonstrate how a line\n break might work?
Or perhaps a
. Multilevel
.. Numbered list
.. Is more
. Useful?
: {Definition} lists, especially when there are many definitions
: {Can be useful} for explaining things
== Finally, a few more blocks
This `section' features "smart quotes".
~~~
{Simple block}
This is a simple text block, with a title. Notice how the previous line has only one set of braces (\{\}).
~~~
~~~
{Interactive Python listing}{pyint}
>>> print 'Interactive Python code.'
'Interactive Python code.'
~~~
~~~
{}{}
Plain code block with no title.
~~~
You might need 2--3 different-sized dashes---they can be useful. Now we're done!