Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add roadmap to 'feature complete' FMark #176

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Roadmap

## arewecompleteyet?

FMark will be "feature complete" when it is possible to write a typical dissertation entirely in fmarkdown.

- [ ] Stable CLI build released & locked down; generates HTML or PDF.
- [ ] Be able to process long files without StackOverflow (tail recursive or incremental processing).
- Note: With page breaks, could process each "page" individually.
- [ ] Page breaks/page numbering.
- [ ] Table of contents
- [ ] References
- [ ] Tables
- [ ] Labels for figures/images/tables

## Extensions

- [ ] Styling
- [ ] Easy CSS integration
- [ ] Fonts
- [ ] Page styling
- [ ] Formattable $(today) datestamp
- [ ] References
- [ ] Chicago
- [ ] Harvard

## Further work

- [ ] Performance/speed test each component (e.g. I have a suspicion our table parsing mechanism could be optimised a lot, but don't know if it's worth it. Let's check which parts are slowly us down the most.)