blob: 8855318cf7063e7584c5daf332a8cb69224dd4f7 (
plain)
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
|
README for demo journal
=============================================================================
This is a demo of how I keep my private journal. In short:
* markdown files (mostly) in git
* [ikiwiki][] renders to HTML (locally or via CI to a website)
- ikiwiki's [inline][] directive helps collect journal entries
- tags and topic pages help collect
- I have a "topic" for each person
* [jt][] helps make entries and maintain the journal (not necessary,
but relieves some tedium)
[ikiwiki]: http://ikiwiki.info/
[inline]: http://ikiwiki.info/ikiwiki/directive/inline/
[jt]: http://git.liw.fi/jt
To use:
* install ikiwiki
* clone this repo
* edit ikiwiki.setup to set paths appropriately
* run ikiwiki --setup ikiwiki.setup
* open the output files in a web browser or sync the files to a web
server -- ikiwiki renders static pages, and does not need to be
installed on the server
* create journal entries as notes/YYYY/MM/DD/basename.mdwn -- see
examples
|