search

gtojty / pyemread

package for creating bitmaps, region files, and analyzing ascii eye-movement data
2 stars 1 forks source link

documentation file format #5

Open davebraze opened 8 years ago

davebraze commented 8 years ago

Consider converting this file: https://github.com/gtojty/emf_rp/tree/master/docs from docx to rst or *md format to ease maintenance and provision of alternative target formats (e.g., pdf, html).

Would probably use pandoc for initial conversion (docx >> md), but would likely need some additional cleanup after the fact.

gtojty commented 8 years ago

i now use pandoc to change docx to md

davebraze commented 8 years ago

So now we should maintain the file Doc_20160801.md as the primary documentation file. The docx version can be deleted from the repository.

gtojty commented 8 years ago

I will keep the word file, in case for future publication writing. Besides, in the md file, some subtitle (like Output) is not well shown in html case. In addition, it is not that easy to edit in md such a big word document. So I will keep both, though the transtion from word to md is straightforward now via pandoc.