[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Writing up some docs



Hi folks,

I started a new repository, debian/xsf-docs.git, to hold some
documentation. I picked the markdown (*.mdwn) language, since it's
what I use in ikiwiki for blogging, and I didn't find major drawbacks
until now. I wrote a tiny Makefile and a tiny shell wrapper to
generate html, “make html” does that. It's also possible to generate
pdf files, using the wbhtmltopdf tool (based on webkit), that's done
using “make pdf”. “make” or “make all” run both.

I've cloned it in pkg-xorg's htdocs on alioth, and set up a crontab:
| PATH=/usr/bin:/bin
| MAILTO=""
| XSF_DOCS=/home/groups/pkg-xorg/htdocs/xsf-docs
| 0 * * * * cd $XSF_DOCS && git pull --rebase && make html

(IOW: a refresh happens every hour.)

That leads to:
  http://pkg-xorg.alioth.debian.org/xsf-docs/

I'll be trying to migrate appropriate stuff from the wiki to there, in
an attempt to lower wiki entropy. Of course, you're welcome to
contribute, either by pushing updates or by sending patches!

I'm not sure it warrants its own source/binary package, but at any
rate, it's probably a good idea to ship it to users, recommending
whatever binary it's going to belong to from another package people
are very likely to have installed.

Mraw,
KiBi.

Attachment: signature.asc
Description: Digital signature


Reply to: