Skip to content
forked from mb21/panwriter

Markdown editor with pandoc integration and paginated preview.

License

Notifications You must be signed in to change notification settings

Skeeve/panwriter

 
 

Repository files navigation

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 for more info.

Download PanWriter

You also have to install pandoc to export to most formats.

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

Develop

Install git and yarn, then:

git clone [email protected]:mb21/panwriter.git
cd panwriter
yarn install

## To run the app in development mode:
yarn run electron:dev

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

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

TODOs

  • Preview:
    • respect css, toc metadata fields
  • Editor:
    • expand Format menu
    • spell check
    • improve find/replace
  • add a Settings/Preferences window (or should this just be a settings.yaml file?) where you can:
    • set a CodeMirror editor theme css
    • edit the default CSS and YAML files
    • choose pandoc executable (probably with file-open dialog, which we can use for app sandboxing with security-scoped bookmarks)
  • Write pandoc lua filter that does some PanWriter-specific transformations:
  • GUI popup on file import: at least allow to set -f, -t, --track-changes and --extract-media pandoc options.
  • Unify PanWriter custom document type and pandoc template concepts?
  • Rename type metadata key to doctype?

Powered by

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

About

Markdown editor with pandoc integration and paginated preview.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 74.4%
  • CSS 24.7%
  • HTML 0.9%