https://github.com/mb21/panwriter

Markdown editor with pandoc integration and paginated preview.
https://github.com/mb21/panwriter

editor electron markdown markdown-converter markdown-editor pandoc pandoc-ui react

Last synced: 6 days ago
JSON representation

Markdown editor with pandoc integration and paginated preview.

• Host: GitHub
• URL: https://github.com/mb21/panwriter
• Owner: mb21
• License: gpl-3.0
• Created: 2018-11-03T14:42:43.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-11-19T03:22:34.000Z (23 days ago)
• Last Synced: 2024-11-21T06:02:42.441Z (21 days ago)
• Topics: editor, electron, markdown, markdown-converter, markdown-editor, pandoc, pandoc-ui, react
• Language: TypeScript
• Homepage: https://PanWriter.com
• Size: 4.57 MB
• Stars: 1,063
• Watchers: 21
• Forks: 52
• Open Issues: 41
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - mb21/panwriter - Markdown editor with pandoc integration and paginated preview. (react)

README

        


# PanWriter

PanWriter is a distraction-free markdown editor with two unique features:

1. Tight integration with pandoc for import/export to/from plenty of file formats (including HTML, docx, LaTeX and EPUB).

2. Preview pane that can show pages – including page breaks etc. Layout adjustments are immediately reflected in the preview.

Read the **[MANUAL](https://www.panwriter.com/MANUAL.html)** for more info.

**[Download PanWriter](https://www.panwriter.com)**

- You also have to [install pandoc](https://pandoc.org/installing.html) to export to most formats.

- If you're on macOS, see this [thread on how to bypass the security warning](https://github.com/mb21/panwriter/issues/33#issuecomment-2354944902).

![](screenshot.png)

Feedback, suggestions and contributions very much welcome! Please open an issue to start a conversation.

## Develop

Install git (if you haven't already) and [install Volta](https://docs.volta.sh/guide/getting-started) (which will make the correct Node.js and npm versions availlable in the project directory), then:

    git clone [email protected]:mb21/panwriter.git

    cd panwriter

    npm ci

    ## To run the app in development mode:

    npm run electron:dev

    ## To build distributable app package (goes to ./dist):

    npm dist

Check out the `package.json` for more scripts to run.

## Powered by

PanWriter is powered by (amongst other open source libraries):

- [pandoc](http://pandoc.org) (import/export)

- [Electron](https://electronjs.org) (app framework)

- [CodeMirror](https://codemirror.net) (editor)

- For the preview pane:

    - [pagedjs](https://gitlab.pagedmedia.org/tools/pagedjs)

    - [markdown-it](https://github.com/markdown-it/markdown-it#markdown-it)

    - [KaTeX](https://katex.org)