TODO
Couple of TODO items copied from John’s website and added a some QoL items of my own!
-
Title: Change the default for doc title. If no
% title DOC_TITLE
block found, then instead of quitting, simply use the filename as a sane default. - Copyright: Auto create the copyright information based on some command line args string. Add a sane default with fun name!
-
Document Footer:
- Remove the option to view pandoc markdown source
- Update link to rippledoc repo to point to custom repo with my changes
- Edit string for copyright to remove the word copyright!
- Add last modified: date, time and timezone.
-
Links: write pandoc filter to auto-convert internal markdown links to html. This will ensure inter-linking of files is preserved even when converted to html. See this stack overflow thread for ideas about how to implement this.
-
Embed the filter inside
rippledoc.py
and use that instead of requiring users to supply the file. Of course, if they supply a file, also use that!
-
Embed the filter inside
- Style: Edit the default css file according to your needs!
-
Output: Option for writing html files to a custom
_site
dir. - Help Docs: Create a list of docs and host them on your github webpage. Refer the help message of this website to the edited docs.
-
Cleanup: Add feature to clean up all generated files
-
--clean
: remove all generated .html, toc.conf, and styles.css files -
--modified
: shows which md files have been modified and need processinng
-
- Title in browser window & bookmark should include project name
- Check to make sure there’s at least one doc file present other than index.md.