icon-madoko

Madoko
Write Beautiful Documents


Madoko is a fast markdown processor for writing professional articles, books, manuals, webpages and presentations, with a focus on simplicity and plain text readability.

With Madoko you can write complex documents completely in markdown and get beautiful PDF and HTML output.

Start editing…

sshot-focus

sshot-presentation

Madoko for presentations

Using the reveal.js framework, we can create great presentations in Markdown and view it in any browser. Using the beamer package, we can also generate PDF presentations from the same source.

Start a presentation…Presentation example (HTML)

$\textrm{Madoko}$ $= \mbox{\LaTeX} \times \textrm{Markdown}^2$

Write full-blown academic articles with internal references, mathematical formulas, and bibliographies.

Madoko uses LaTeX to translate formulas and standard bibliography BibTeX files, and can typeset using any LaTeX document style.

Using Markdown is much more pleasant than writing LaTeX directly, and your article will look great in both in HTML and PDF. Madoko is especially good when needing text tranformations, code fragments that need highlighting or proportional fonts, styling through CSS rules, etc.

Start an article…
Example (PDF)Example (HTML)

sshot-article-med

icon-dropbox icon-github icon-onedrive

Madoko integrates seamlessly with Dropbox, Github, and, Onedrive, and automatically synchronizes all changes in the cloud. This way, your document is always available anywhere from any device.

share

Through Dropbox and Github, it is easy to share documents with others. Everyone can edit the document where concurrent changes are automatically merged by Madoko (using robust three-way merges).

Madoko for webpages


1
Madoko

icon-madoko

+

2
Dropbox

icon-dropbox

⇒

3
Azure website

icon-azure & icon-bootstrap


Madoko uses Bootstrap and Dropbox to deploy great looking web pages instantly to Azure.

Start a webpage…

FAQ

  1. How is Madoko different?
    Madoko implements many features beyond markdown to enable writing serious documents completely in Markdown while giving excellent PDF and HTML output. Read the reference manual to learn more.

  2. Does the Madoko server store any documents?
    No, the madoko server just processes mathematical formulas, bibliographies, and PDF exports. All data is sent over an encrypted connection and immediately removed after processing.

    Documents are only stored locally in your browser, and on your personal cloud storage. Nothing is retained on the Madoko server.

  3. How can you show a preview?
    All the rendering for the preview and HTML export is done locally in the browser on your computer – Madoko is a Javascript program written in Koka and runs inside the browser.

  4. Do I need to save my document?
    No, Madoko continuously saves the current document in browser local storage. You can at any time close the browser or shutdown the computer and your changes are saved. Madoko also automatically synchronizes your changes to the cloud storage every 30 seconds or so. At this point, all your changes become visible to any other devices (and other users if you share the document on Dropbox)

    When the local document is synchronized with the cloud, the centered dot behind the name disappears and you know your local changes are backed up in the cloud.

  5. Can I work concurrently with other users on a document?
    Yes, Madoko merges concurrent changes automatically. However, currently only Dropbox and Github support full sharing of files in the cloud. Onedrive does not support such sharing at this time.

  6. Is there version control?
    When documents are used from Github, full version control is provided and “saving” a document becomes a commit. Also, Dropbox maintains a complete version history of every file automatically (up to 30 days).

    Moreover, in Madoko you can use the “Save a snapshot” menu to save a full copy of the document into a snapshot/document-date sub-folder. Finally, you can also set up regular version control through Git or Mercurial in your cloud synchronized folder.

  7. Can I write my academic paper, manual, book, thesis, etc. in Madoko instead of LaTeX?
    Yes! and Madoko makes it especially easy to work with others through Dropbox or Github. It is fairly safe to try out Madoko to write your next paper since:

    • Using TexRaw blocks you can always fall back to plain LaTeX in a pinch.
    • Using the command line version of Madoko you can always locally render the document even if the internet is down.
    • Madoko continuously synchronizes and backs up your document to the cloud making the document available anywhere on any device.

    • Edit this example of a real article with heavy mathematics and code to see how such article can look.

  8. The editor has ‘hick-ups’!
    Go to the settings menu (top right) and enable delayed view updates. This will only update the view if there is a small pause in typing which makes the editor much more responsive on a slow browser or large document.

  9. What browsers are supported?
    Madoko.NET has been tested with Chrome version 31+, IE 10+, and Firefox version 27+. Unfortunately, Firefox has a tendency to become slow for larger documents.

  10. Can I run Madoko locally?
    Yes! Madoko is free software and runs as a command line program on any system that can run nodejs (Windows, MacOSX, Linux, etc). Follow the installation instructions in the reference manual. This means that you can always continue working on important documents even if the internet is down.

  11. Does Madoko.net work if I am not connected? Yes, Madoko is a “web-app” and works without an internet connection. However, Madoko cannot render mathematical formulas or synchronize to the cloud storage in off-line mode.

  12. What software does Madoko use? 

    • NodeJS
    • Express
    • Madoko is written in the Koka language.
    • Madoko is free software and available on codeplex under the Apache 2.0 license

  13. Any useful links?

Enjoy :-)
  – Daan Leijen