diff options
| author | Yann Herklotz <ymherklotz@gmail.com> | 2018-01-26 16:15:49 +0000 |
|---|---|---|
| committer | Yann Herklotz <ymherklotz@gmail.com> | 2018-01-26 16:15:49 +0000 |
| commit | cfd01afa075c0c1bb19f5f38db874760fc86a7d9 (patch) | |
| tree | 4d3d59ddafe4856d875615a448f11a92ae1dfce9 /README.md | |
| parent | d2103c7b62a5fa42e78bb59f0202e4797931516d (diff) | |
| download | FMark-cfd01afa075c0c1bb19f5f38db874760fc86a7d9.tar.gz FMark-cfd01afa075c0c1bb19f5f38db874760fc86a7d9.zip | |
[doc] Adding readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 49 |
1 files changed, 49 insertions, 0 deletions
@@ -1,2 +1,51 @@ # FMark FSharp markdown. + +## Features + +- Generating html +- Lexer for markdown +- Parser for markdown + +### MarkDown + +- Headers +- Paragraphs +- Lists +- Links +- BlockQuoting +- Picture embedding +- Tables +- Code box +- Text attributes +- Frontmatter / Metadata + +### Extra + +- Math equation rendering (Mathjax) +- Citation +- Table of contents +- Spreadsheet functionality + +### Desirable Result +- Extensible Code + - Add names to features, so users can render them differently + such as editing the type of citation used and how to output them. +- User defined delimiters / patterns -> Ask Tom + +### Maybe's + +- References +- Realtime rendering +- Diagrams (Graphviz) -> Proof that it is extensible +- autoformatting + +## Splitting + +Global Types +<h1 opt="hi"> </hi> + +Person1 - Lexer +Person2 - Formatting / print HTML: Header, Paragraph, Lists, Table -> Simple parser +Person3 - Tables: Spreadsheet, DSL +Person4 - Citations (extensible), Table of contents -> Simple Parser
\ No newline at end of file |