Skip to content

fs-geofs/Protokollfix

Repository files navigation

logo

"LaTeX sucks - markdown too."

  • some person

This is just another markdown editor for the browser.

It has some features that might make it interesting though:

features

  • read/write on file system
    • documents are read/written directly on the servers filesystem, which makes their use in other applications really easy
    • this also means that this application does not scale well, and is intended for single- (or few-) user scenarios only
  • create documents from templates
  • insert custom text snippets
  • proper editor with syntax highlighting, undo, autoindent, drag/drop & shortcuts
  • exports through pandoc integration
    • directly convert & download documents using pandoc.
    • technically all pandoc supported formats can be used, currently implemented are PDF, HTML5, DOCX, LaTeX, reveal.js, MediaWiki, DokuWiki
  • http auth for private access. authentication may be restricted to the save functionality for public read-access
  • mailto link for the current document
  • view mode, which hides the editor for a pure presentation of the document

dependencies

install

  1. install the above dependencies. On Debian based distros run

     curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -
     sudo apt-get install nodejs pandoc texlive
    
  2. clone this repo & install npm & bower dependencies

     git clone https://github.com/fs-geofs/Protokollfix.git
     cd Protokollfix
     npm install
    

If npm reports issues installing bower globally, change the path to global npm packages to a directory you have write access to, which is a good idea anyway. Alternatively install bower with sudo (sudo npm install -g bower) & run bower install manually.

run

Check ./config.js and make changes if needed, then run

npm start

By default the server will listen on http://localhost:8080.

For debug output you may run npm test.

license

GPL-3.0

Used software packages are licensed under their own terms.

TODO

About

markdown editor in the browser with pandoc integration

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published