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
/
stuff.jemdoc
executable file
·58 lines (46 loc) · 1.48 KB
/
stuff.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
56
57
58
# jemdoc: menu{MENU}{stuff.html}
= jemdoc -- vim, make
== Vim syntax highlighting
Here is a vim syntax file {{<a href="dist/jemdoc.vim"
onclick="javascript:urchinTracker('/downloads/jemdoc.vim');">jemdoc.vim</a>}}.
You should download it to
+\~\/.vim\/syntax\/+. You may also need to add the following lines in your
+\~\/.vimrc+:
~~~
{Additional +\~\/.vimrc+ lines}{}
filetype plugin on
augroup filetypedetect
au! BufNewFile,BufRead *.jemdoc setf jemdoc
augroup END
" Last line is for proper wrapping of jemdoc lists, etc.
autocmd Filetype jemdoc setlocal comments=:#,fb:-,fb:.,fb:--,fb:..,fb:\:
~~~
== Makefile
Here's a small example of a {{<a href="dist/Makefile"
onclick="javascript:urchinTracker('/downloads/Makefile');">Makefile</a>}}.
A listing of it follows.
This file would be used as follows:
- Edit +index.jemdoc+ and +otherpage.jemdoc+ at will.
- Type +make+ in the same directory, and files +html\/index.html+ and
+html\/otherpage.html+ will be updated as necessary.
- Type +make update+ and your files will be copied to the server.
- Type +make clean+ and old +html+ files in +html\/+ will be removed.
Rinse and repeat.
~~~
{Makefile example}{}
DOCS=index otherpage
HDOCS=$(addsuffix .html, $(DOCS))
PHDOCS=$(addprefix html/, $(HDOCS))
.PHONY : docs
docs : $(PHDOCS)
.PHONY : update
update : $(PHDOCS)
@echo -n 'Copying to server...'
# insert code for copying to server here.
@echo ' done.'
html/%.html : %.jemdoc MENU
jemdoc -o $@ $<
.PHONY : clean
clean :
-rm -f html/*.html
~~~