Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yasumichi/seapig
SeaPig is converter from markdown to html with marked.js and highlight.js.
https://github.com/yasumichi/seapig
Last synced: about 2 months ago
JSON representation
SeaPig is converter from markdown to html with marked.js and highlight.js.
- Host: GitHub
- URL: https://github.com/yasumichi/seapig
- Owner: yasumichi
- License: mit
- Created: 2016-08-13T03:35:15.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-11-02T00:59:15.000Z (almost 5 years ago)
- Last Synced: 2024-07-29T04:44:01.850Z (about 2 months ago)
- Language: JavaScript
- Homepage: https://yasumichi.github.io/seapig/
- Size: 2.19 MB
- Stars: 74
- Watchers: 5
- Forks: 15
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - yasumichi/seapig - SeaPig is converter from markdown to html with marked.js and highlight.js. (others)
README
SeaPig
=====
SeaPig is converter from markdown to html with marked.js and highlight.js.
## Usage
SeaPig has two panes. Left pane is editor. Right pane is HTML previewer.
When you input markdown, SeaPig refresh HTML preview.
You can use [GitHub Flavored Markdown](https://github.github.com/gfm/).
SeaPig has tool bar contains one drop down list and eight buttons.
You can select key bindings from drop down list. (default/emacs/vim/sublime)
Eight buttons has feature below.
- New markdown file (Open new window)
- Open markdown file to editor.
- Save markdown file from editor.
- Export HTML file from previewer.(At the same time css stylesheet is copied to same folder.)
- Export PDF file
- Hide editor
- Hide previewer
- Refresh HTML preview
### viz.js support
When You write code block as `graphviz` language and write dot language, rendering graph image at svg as below.
```graphviz
digraph g { a -> b; }
```
to
### uiflow support
When You write code block as `uiflow` language and write uiflow language, rendering graph image at svg as below.
```uiflow
[top page]
user name
password
--
login
==>mypage
[mypage]
favorite list
```
to
### MathJax support (code block only)
```math
E=mc^2
```
to
More example, [test/mathjax.md](test/mathjax.md)
### mermaid support
When You write code block as `mermaid` language and write mermaid language, rendering graph image at svg as below.
```mermaid
sequenceDiagram
participant main
participant renderer
participant previewer
main->>renderer: Open file
renderer->>previewer: Refresh preview
```
to
## For developers
### How to build
```
$ git clone https://github.com/yasumichi/seapig.git
$ cd seapig
$ git submodule update -i
$ npm install
$ npm build-dep
...
```
### How to lunch
```
$ npm start
```
### How to package
```
$ npm run package:win32
```
### How to package all (on Linux)
```
$ ./build.sh
```
## ToDo
- [x] save your favorite keybindings (default/emacs/vim)
- [x] support task list item.
- [x] add viz.js support
- [x] add [uiflow](https://github.com/hirokidaichi/uiflow) support.
- [x] add mermaid support
- [x] add simultaneous scroll
- [x] add original menu
- [x] add new document
- [ ] add alternative stylesheet
- [x] control display editor and previewer
- [ ] add batch mode
- [x] introduce virtual dom framework (mithril.js)
## Special Thanks
- [Ace - The High Performance Code Editor for the Web](https://ace.c9.io/)
- [Electron - Build cross platform desktop apps with JavaScript, HTML, and CSS.](http://electron.atom.io/)
- [electron-json-storage](https://github.com/jviotti/electron-json-storage)
- [electron-localshortcut](https://github.com/parro-it/electron-localshortcut)
- [Github Markdown CSS - for Markdown Editor Preview](https://gist.github.com/andyferra/2554919)
- [highlight.js](https://highlightjs.org/)
- [marked](https://github.com/chjj/marked)
- [MathJax](https://www.mathjax.org/)
- [mermaid](https://knsv.github.io/mermaid/)
- [mithril](https://mithril.js.org/)
- [Node.js](https://nodejs.org/en/)
- [Photon](http://photonkit.com/)
- [sanitize-html](https://github.com/apostrophecms/sanitize-html)
- [viz.js](https://github.com/mdaines/viz.js)
- [uiflow](https://github.com/hirokidaichi/uiflow)(use [forked version](https://github.com/tkrkt/uiflow#fix-argument-in-compile))
- [いらすとや](http://www.irasutoya.com/)(application icon)
- [jpzukin/electron-sample-print-to-pdf](https://github.com/jpzukin/electron-sample-print-to-pdf)
# License
MIT (excludes photon, node_modules and icons)
Copyright © 2016-2019 Yasumichi Akahoshi
# Icons copyright
- seapig.icns
- seapig.ico
- seapig.png
Copyright © いらすとや. All Rights Reserved.