hirotoshioi / scrapbox

Scrapbox parser and renderer

scrapbox

scrapbox is a parser library for scrapbox.

scrapbox can be used in several ways:

• Parse given scrapbox page and express them as structured tree
• Parse commonmark and either express them as structured tree or convert it into scrapbox page
• (Experimental) Convert given scrapbox page into commonmark

The library is well-tested including round-trip test which tests whether given arbitrary tree can be rendered, then parsed as original tree.

Known issues

• When parsing commonmark, it cannot parse CUSTOM_INLINE, CUSTOM_BLOCK, THEMATIC_BLOCK properly
• When parsing scrapbox, some of the inline styles cannot be parsed correctly
• When parsing scrapbox, it cannot parse correctly when user-defined styles are being used.

scrapbox's Issues

Export as Library

Render scrapbox data type into commonmark

Render scrapbox data type into commonmark.

This enables the library to:

• Convert given scrapbox page into commonmark.
• Convert the backup file into list of commonmarks.

Change data structure of ITEM

Make it so that the ITEM takes list of styles instead of single style

Create readme

Create readme for the library

Refactor test codes

Since there's 700+ lines of code for testing the parser, let's split up the test suites.

Implement paragraph parser on commonmark

Cmark miss out some of syntax, implement parser for it.
example:
Bold with no spaces: Helloworld
Strikethrough: Helloworld
In some situation, Heading:
##Hello world

Implement test case on image

Restructure test suites of scrapbox parser

Test suites on scrapbox parser is getting convoluted.
https://github.com/HirotoShioi/scrapbox/blob/master/test/ParserTest.hs
Tear it down into smaller modules

Add test cases for scrapbox parser

Add test case for

• item parser
• inline text parser
• scrapbox parser

Implement table parser

Thinking of using attoparsec.

http://hackage.haskell.org/package/attoparsec
https://www.schoolofhaskell.com/school/starting-with-haskell/libraries-and-frameworks/text-manipulation/attoparsec
https://sites.google.com/site/toriaezuzakki/haskell/attoparsec