2 |
3 | [jemdoc](https://jemdoc.jaboc.net/) (or [jemdoc+MathJax](http://www.mit.edu/~wsshin/jemdoc+mathjax.html)) has always been a good choice for light static website generating.
4 |
5 | Yet, now it has a new design. If you know how to use [jemdoc](https://jemdoc.jaboc.net/), there is no learning curve. The usage is exactly the same.
6 |
7 | **Demo:** [https://szl2.github.io/jemdoc-new-design/www/index.html](https://szl2.github.io/jemdoc-new-design/www/index.html)
8 |
9 | 
10 |
11 | ## Download
12 |
13 | You need to download `./jemdoc`,`./www/main.css`, `./www/table.css` and `./jemdoc_files/mysite.conf` files.
14 |
15 | Notice that, **you have to download the `./jemdoc` excutable, because there were some modification from the original one in [`jemdox+Mathjax`](https://szl2.github.io/jemdoc-new-design/www/index.html)**.
16 |
17 | The usage is exactly the same as [`jemdoc`](https://jemdoc.jaboc.net/). Refer [this page](https://jemdoc.jaboc.net/) for how to jemdoc.
18 |
19 | ## Usage
20 |
21 | Assuming you have already install the `jemdoc+MathJax`, notice that
22 |
23 | in `./jemdoc_files/`, we store `.jemdoc` files and `mysite.conf`
24 |
25 | in `./www/`, we store the output `.html` / `.css` / `.js` files and website assets.
26 |
27 | Suppose you are currently in `./jemdoc_files/`, we use the following to compile
28 |
29 | ```
30 | python ../jemdoc -c mysite.conf -o ../www/ *.jemdoc
31 | ```
32 |
33 | You can also use this for single page generation or all page generation by using `*.jemdoc`.
34 |
--------------------------------------------------------------------------------
/jemdoc_files/MENU:
--------------------------------------------------------------------------------
1 | About [index.html]
2 |
3 | My Templates
4 | Profile Page [profile.html]
5 | Blog Post Page [post1.html]
6 | Project Page [projects.html]
7 | Group Page [group.html]
8 |
9 | Jemdoc
10 | download [download.html]
11 | version/bug info [revision.html]
12 | contact [contact.html]
13 |
14 | User's guide
15 | running jemdoc [using.html]
16 | example page [example.html]
17 | example page (no menu) [nomenu.html]
18 | cheat sheet [cheatsheet.html]
19 | extra syntax [extra.html]
20 |
21 | Configuration
22 | html changes [htmlchanges.html]
23 | adding a menu [menu.html]
24 | modelines [modelines.html]
25 |
26 | Goodies
27 | vim, make [stuff.html]
28 | latex equations [latex.html]
29 | tables [tables.html]
30 |
31 | Additional Features
32 | MathJax [mathjax.html]
33 | Underscore [underscore.html]
34 | Link [link.html]
35 | Open in New Tab [\http://www.google.com]
36 |
--------------------------------------------------------------------------------
/jemdoc_files/Makefile:
--------------------------------------------------------------------------------
1 | DOCS=index cheatsheet contact download revision using menu stuff extra example modelines htmlchanges latex tables
2 |
3 | HDOCS=$(addsuffix .html, $(DOCS))
4 | PHDOCS=$(addprefix html/, $(HDOCS))
5 |
6 | .PHONY : update
7 | update : $(PHDOCS)
8 | @echo -n 'Copying to (hidden) server...'
9 | @rsync -a --delete --copy-unsafe-links *.jemdoc html/* dist eqs ~/jemdoc/stage/
10 | @echo ' done.'
11 |
12 | .PHONY : extra
13 | extra :
14 | cp ~/.vim/syntax/jemdoc.vim dist/
15 |
16 | .PHONY : docs
17 | docs : $(PHDOCS)
18 |
19 | html/%.html : %.jemdoc MENU jemdoc.conf
20 | ~/jemdoc/jemdoc -o $@ -c jemdoc.conf $<
21 |
22 | example.jemdoc : exampleIN.jemdoc procexample.py
23 | @echo 'making exampleIN'
24 | @./procexample.py
25 |
26 | .PHONY : realupdate
27 | realupdate : $(PHDOCS)
28 | @echo -n 'Copying to (hidden) server...'
29 | @rsync -a --delete --copy-unsafe-links *.jemdoc html/* dist ~/jemdoc/stage/
30 | @echo ' done.'
31 | @echo 'Copying to moa...'
32 | rsync -a --delete --copy-unsafe-links *.jemdoc ~/jemdoc/stage/ moa:/var/www/jemdoc/
33 | @echo ' done.'
34 |
35 | .PHONY : clean
36 | clean :
37 | -rm -f html/*.html
38 |
--------------------------------------------------------------------------------
/jemdoc_files/cheatsheet.jemdoc:
--------------------------------------------------------------------------------
1 | # jemdoc: menu{MENU}{cheatsheet.html}
2 | = jemdoc -- cheatsheet
3 |
4 | == Basic formatting
5 | - /\/italics\//
6 | - *\*bold\**
7 | - +\+monospace\++
8 | - +\-+ is a hyphen (-)
9 | - +\-\-+ is an en-dash (--)
10 | - +\-\-\-+ is an em-dash (---)
11 | - +\.\.\.+ is an ellipsis (...)
12 | - +\~+ is a non-breaking space (~)
13 | - +\#+ begins a comment, for the remainder of the line
14 | - +\\C+ is \C
15 | - +\\R+ is \R
16 | - +\\M+ is \M
17 | - `singly quoted text' is written +\`singly quoted text\'+
18 | - "doubly quoted text" is written +\"doubly quoted text\"+
19 | - jemdoc's apostrophes are converted automatically from +jemdoc\'s+ input
20 | - the sequence +\\n+ \n forces a manual line break
21 | - paragraphs are separated by blank lines
22 | - +\$inline LaTeX equation\$+
23 | - +\\( LaTeX equation on its own line \\)+
24 | - +\#+s (and only +\#+s) must be quoted in URLs
25 |
26 | == Blocks
27 | ~~~
28 | {Code block syntax}{}
29 | \~~~
30 | \{Optionally empty title}{Optionally empty highlight mode}
31 | Code block with monospaced text.
32 | \~~~
33 | ~~~
34 |
35 | ~~~
36 | {Information block}
37 | Omit the second pair of braces in the first line of the block (or omit the whole
38 | first line altogether if you don't want a title) and you will get an
39 | /information block/. All the usual conventions apply in here.
40 | ~~~
41 |
42 | == Headings and lists
43 | Headings are defined by starting a line with +=+.
44 | - += Heading level 1+
45 | - +== Heading level 2+, /etc./
46 |
47 | Lists are defined with +-+ for bulleted lists, +.+ for numbered lists and +:+
48 | for lists of definitions. Here is some code and the resulting list:
49 |
50 | ~~~
51 | {}{}
52 | - Bullet level one
53 | -- Bullet level two
54 |
55 | . Number level one
56 | .. Number level two
57 | .. Number level two (again)
58 |
59 | : {jemdoc} light markup
60 | : {asciidoc} a great alternative, but more complicated
61 | ~~~
62 |
63 | ~~~
64 | - Bullet level one
65 | -- Bullet level two
66 |
67 | . Number level one
68 | .. Number level two
69 | .. Number level two (again)
70 |
71 | : {jemdoc} light markup
72 | : {asciidoc} a great alternative, but more complicated
73 | ~~~
74 |
75 | == Preventing matches
76 | - a literal backslash (\\) is written +{{\\\\}}+
77 | - the literal characters \/, \*, \+ and \~ and \# are written +\\/+, +\\*+,
78 | +\\\++, +\\\~+ and +\\\#+ to avoid the above formatting
79 | - +\\\...+ avoids an ellipsis
80 | - +-\\-+ avoids an en-dash
81 | - +-\\-\\-+ avoids an em-dash
82 | - +\\\`+ gives a back-tick (\`)
83 | - +\\\'+ gives an ordinary single quotation mark (\')
84 | - +\\\"+ gives an ordinary double quotation mark (\")
85 |
86 | == Other stuff
87 | - +\{\{html text\}\}+ will insert +html text+ directly into the output document
88 | without performing any substitutions. (This is for inline escaping; use
89 | [extra.html raw blocks] for larger amounts of html.)
90 | - +\%quoted tt\%+ is an alias for +\+{\{quoted tt\}\}\++. It's not quite as
91 | robust, so use +\+{\{plus signs with double brace blocks}\}\++ if you run into
92 | problems with some characters.
93 | - +{\\{text}\\}+ /will/ perform replacements and insert {\{text}\}.
94 |
95 | This page is not exhaustive.
96 |
--------------------------------------------------------------------------------
/jemdoc_files/contact.jemdoc:
--------------------------------------------------------------------------------
1 | # jemdoc: menu{MENU}{contact.html}
2 | = jemdoc -- contact details
3 |
4 | == Development
5 | jemdoc is developed by [http://stanford.edu/~jacobm/ Jacob Mattingley].
6 | Please [jacobm@stanford.edu contact Jacob] with any bug reports and
7 | comments.
8 | If reporting a bug, please run the command +jemdoc -\-version+ and include the
9 | result in your email.
10 |
11 | There are two levels of support:
12 | - Basic jemdoc, which I will attempt to support well, and
13 | - LaTeX equations in jemdoc, which I may attempt to support.
14 |
--------------------------------------------------------------------------------
/jemdoc_files/download.jemdoc:
--------------------------------------------------------------------------------
1 | # jemdoc: menu{MENU}{download.html}
2 | = jemdoc -- download
3 |
4 | Here is {{jemdoc.py}}
6 | (+v0.7.3+). You can also download this [dist/jemdoc.css example css
7 | file] to get you started. You can easily modify the css to adjust colours, fonts
8 | and general layout elements to your taste.
9 |
10 | You may like to %sudo cp jemdoc.py /usr/bin/jemdoc%
11 | so that you can just type
12 | +jemdoc+; alternatively, you could add a line to your %~/.bashrc% or
13 | similar like %alias jemdoc='/somepath/jemdoc.py'%. Remember to +chmod \+x+ your
14 | file to make it executable.
15 |
16 | jemdoc requires Python~2.3 or later. If you have a working installation of
17 | Python, you should be ready to go. This includes all Macs, and almost any
18 | fairly modern unix or linux.
19 |
20 | [dist/ Old versions] can still be found. Mahesh Shastry provides a package with
21 | [http://www.personal.psu.edu/mcs312/miscellany.html\#portablejemdoc
22 | jemdoc compiled for Windows].
23 |
24 | == Where to next?
25 | Read about [using.html how to use jemdoc], check out an [example.html example
26 | page], then refer to the [cheatsheet.html cheat sheet] once you're underway.
27 | You could also download sample jemdoc code, like the [index.jemdoc index page]
28 | for this website.
29 |
--------------------------------------------------------------------------------
/jemdoc_files/example.jemdoc:
--------------------------------------------------------------------------------
1 | # jemdoc: menu{MENU}{example.html}
2 | = jemdoc -- example page
3 | [https://jemnz.com/ Jacob Mattingley] ([www@jemnz.com])
4 |
5 | If the first line of the file starts with +\# jemdoc+, special functions like [menu.html menus] will be used.
6 |
7 | == Example
8 | 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.
9 |
10 | I could write special characters like \#, \$ and \+ by just using a backslash (\\) in front of those characters. Or automatically detect an [www@jemnz.com email address].
11 |
12 | ~~~
13 | Save the file as +index.jemdoc+, say, and simply call +jemdoc index+ (after [download.html downloading jemdoc], of course).
14 | ~~~
15 |
16 | == Next bit, next heading level two
17 | === Getting into level three now
18 |
19 | Why not use a list
20 | - to explain the way you do lists?
21 | - to demonstrate how a line\n break might work?
22 |
23 |
24 | Or perhaps a
25 | . Multilevel
26 | .. Numbered list
27 | .. Is more
28 | . Useful?
29 |
30 |
31 |
32 | : {Definition} lists, especially when there are many definitions
33 | : {Can be useful} for explaining things
34 |
35 |
36 | == Finally, a few more blocks
37 | This `section' features "smart quotes".
38 |
39 | ~~~
40 | {Simple block}
41 | This is a simple text block, with a title. Notice how the previous line has only one set of braces (\{\}).
42 | ~~~
43 |
44 | ~~~
45 | {Interactive Python listing}{pyint}
46 | >>> print 'Interactive Python code.'
47 | 'Interactive Python code.'
48 | ~~~
49 |
50 | ~~~
51 | {}{}
52 | Plain code block with no title.
53 | ~~~
54 |
55 | You might need 2--3 different-sized dashes---they can be useful. Now we're done!
56 |
--------------------------------------------------------------------------------
/jemdoc_files/extra.jemdoc:
--------------------------------------------------------------------------------
1 | # jemdoc: menu{MENU}{extra.html}
2 | = jemdoc -- extra syntax elements
3 |
4 | These are some extended syntax options that may come in useful.
5 |
6 | == Left aligned image blocks
7 | As seen [http://stanford.edu/~jacobm here], for example,
8 | left-aligned image blocks place an image and allow ordinary jemdoc marked-up
9 | text to flow around the right-hand side.
10 | ~~~
11 | {Left-aligned image block syntax}{}
12 | \~~~
13 | \{}{img_left}{FILENAME.IMG}{alt text}{WIDTHpx}{HEIGHTpx}{IMGLINKTARGET}
14 | Ordinary jemdoc markup goes here.
15 | \~~~
16 | ~~~
17 |
18 | All arguments may be left blank, though you should specify an image filename,
19 | and alt text should be descriptive for reasons like
20 | [http://en.wikipedia.org/wiki/Wikipedia:Alternative_text_for_images those given
21 | by Wikipedia].
22 |
23 | == Raw blocks
24 | When placing large amounts of raw html, you should use a raw block instead of
25 | +\{\{inline html escaping\}\}+. As well as cleaner syntax, raw blocks will avoid
26 | having ++ tags in the wrong places. 27 | ~~~ 28 | {Raw block syntax}{} 29 | \~~~ 30 | \{}{raw} 31 | Any text here will be copied straight to the output file without processing. 32 | \~~~ 33 | ~~~ 34 | 35 | == Other character sets 36 | Here's a quick example of how to include text in a language with a different 37 | character set. 38 | 39 | To include Korean ({{}}한국말{{}}), 40 | use something like this: 41 | ~~~ 42 | {}{} 43 | {{}}한국말{{}} 44 | ~~~ 45 | 46 | ([jacobm@stanford.edu Let me know] if you need better support for your 47 | language.) 48 | 49 | == Including other files 50 | The line 51 | ~~~ 52 | {}{} 53 | \#include{otherfile.jemdoc} 54 | ~~~ 55 | will include the contents of +otherfile.jemdoc+ as if the contents were actually 56 | in the ordinary input file (that is, with full jemdoc substitutions). 57 | The line 58 | ~~~ 59 | {}{} 60 | \#includeraw{otherfile.html} 61 | ~~~ 62 | will copy the contents of +otherfile.html+ verbatim to the current position in 63 | the output file (that is, without any jemdoc substitutions). 64 | 65 | == Other packages 66 | - [http://www.polytekniker.dk/about.html Jacob Grunnet] has written 67 | [http://bibover.polytekniker.dk Bibover], a bibtex reference extension for 68 | jemdoc. 69 | - [http://www.seas.upenn.edu/~nghiem/ Truong Nghiem] has written a 70 | [http://www.seas.upenn.edu/~nghiem/software.html filter for exporting 71 | references from JabRef to 72 | jemdoc]. 73 | -------------------------------------------------------------------------------- /jemdoc_files/group.jemdoc: -------------------------------------------------------------------------------- 1 | # jemdoc: menu{MENU}{group.html} 2 | = Group 3 | This page contains all photos of our group. 4 | 5 | ~~~ 6 | {}{img_left}{images/groups/group_all.png}{}{100%}{}{} 7 | ~~~ 8 | 9 | 10 | == Members 11 | {{ 12 |
15 | 16 | Lorem Ipsum 17 | PI, EE 18 |
19 |
22 | 23 | Quisque Velit Odio 24 | Assistant Prof, Statistic 25 |
26 |
29 | 30 | Sollicitudin Quis 31 | Assistant Prof, CS 32 |
33 |
36 | 37 | Dictum Vitae 38 | PhD Student, EE 39 |
40 |
43 | 44 | Condimentum Non 45 | PhD Student, EE 46 |
47 |
50 | 51 | Nibh Morbi 52 | Student, EE 53 |
54 |
57 | 58 | Convallis Volutpat 59 | PhD Student, EE 60 |
61 |
64 | 65 | Feugiat Donec 66 | PhD Student, EE 67 |
68 |
71 | 72 | Nec Purus 73 | PhD Student, Statistic 74 |
75 |
78 | 79 | Gravida Lacinia 80 | PhD Student, Statistic 81 |
82 |
85 | 86 | Proin Consectetur 87 | PhD Student, CS 88 |
89 |
92 | 93 | Sapien Sit 94 | PhD Student, CS 95 |
96 |
99 | 100 | Amet Sagittis 101 | MS Student, EE 102 |
103 |
106 | 107 | Pharetra Volutpat 108 | MS Student, EE 109 |
110 |
113 | 114 | Pellentesque ibh 115 | MS Student, Statistic 116 |
117 |
120 | 121 | Vel Futrum 122 | MS Student, CS 123 |
124 |
127 | 128 | Ut Vitae 129 | MS Student, CS 130 |
131 |
142 | 
143 | 
144 | 
147 | 
148 |
149 | 
150 | 
153 | 
154 | 
155 |
156 |
159 |
160 |
161 |