https://github.com/hirotoshioi/scrapbox

Scrapbox parser and renderer
https://github.com/hirotoshioi/scrapbox

haskell markdown parser scrapbox

Last synced: 23 days ago
JSON representation

Scrapbox parser and renderer

• Host: GitHub
• URL: https://github.com/hirotoshioi/scrapbox
• Owner: HirotoShioi
• License: bsd-3-clause
• Created: 2018-12-12T05:49:58.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-12-06T10:31:59.000Z (about 5 years ago)
• Last Synced: 2025-01-20T00:41:40.278Z (26 days ago)
• Topics: haskell, markdown, parser, scrapbox
• Language: Haskell
• Homepage: https://scrapbox.io/scrapbox-parser/
• Size: 350 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# scrapbox

[![Build Status](https://travis-ci.org/HirotoShioi/scrapbox.svg?branch=master)](https://travis-ci.com/HirotoShioi/scrapbox.svg?branch=master)

`scrapbox` is a parser library for [scrapbox](https://scrapbox.io/product).

`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.