Short:        Markdown editor with HTML preview
Author:       André Gewert <agewert@ubergeek.de>
Uploader:     André Gewert <agewert ubergeek de>
Type:         text/edit
Version:      1.0
Requires:     AmigaOS 3.2, dev/gui/html_gadget.lha (1.1), AISS (toolbar)
Architecture: m68k-amigaos >= 3.2.0
Distribution: Aminet

Kickdown is a Markdown editor for AmigaOS 3.2 with a live HTML preview,
built with ReAction. mdtohtml converts Markdown files to HTML pages from
the Shell. Both use md4c, a fast CommonMark compliant parser written in
C, and understand GitHub flavoured Markdown: tables, strikethrough, task
lists, autolinks and footnotes.

Kickdown
--------
 - editor (texteditor.gadget) and preview (html.gadget) side by side,
   the bar between them adjusts the split
 - syntax highlighting of headings, emphasis, code, quotes, lists, links,
   tables and HTML in the editor, line numbers on request
 - the preview follows half a second after you stop typing and keeps
   its scroll position; editor and preview scroll together
 - headings get anchors, so "#anchor" links and tables of contents
   work; links to other .md files open them in the editor
 - pictures with relative paths are loaded from the document's drawer
 - open, save, save as, export to HTML (with your own page template)
 - cut, copy, paste, undo, redo; text selected in the preview can be
   copied as well
 - find and replace (case sensitive, whole words, backwards, wrap
   around, replace all as one undo step)
 - formatting from the toolbar and the Format menu: heading, bold,
   italic, underline, code, link, image, bulleted, numbered and task
   list, quote; on the selection or the lines, each one undo step
 - toolbar with AISS images (TBIMAGES:), images and text or text only,
   flat or with frames; buttons that would do nothing are ghosted,
   buttons that do not fit into a narrow window are in a drop-down list;
   the formatting buttons can be hidden
 - AppWindow: drop a Markdown icon on the window to open it; iconify
 - splash window while starting (can be switched off)
 - settings window: editor, preview (renderer, TrueType fonts), Markdown
   dialect, charset, page template, highlighting colours, window size
   and position, toolbar; saved as tool types of the Kickdown icon
 - options as tool types or Shell arguments:
   Kickdown [FILE] <name.md> [TEMPLATE <file>] [CHARSET <name>]
            [DIALECT GitHub|CommonMark] [TTF] [NOAUTOREFRESH] [NOSYNC]
            [NOHIGHLIGHT] [LINENUMBERS] [FONTSET Vera|DejaVu|Noto] [SIZE n]
   TTF uses htmlttf.gadget (anti-aliased TrueType fonts) for the preview.

mdtohtml
--------
   mdtohtml [FROM] <file.md> [TO <file.html>] [TEMPLATE <file>]
            [CHARSET <name>] [TITLE <text>] [DIALECT GitHub|CommonMark]

Without FROM the text is read from standard input, without TO the page
goes to standard output. The title defaults to the first heading. The
charset is only written into the page: UTF-8 if the text is valid UTF-8,
otherwise ISO-8859-1. Raw HTML in the text is passed through.

A template is an HTML file with the placeholders $title$, $encoding$ and
$body$, see Template.html.

Installation
------------
Double click Install: it copies Kickdown with the page template and the
example into a drawer of your choice, mdtohtml to C:, the documentation,
and the catalogs of the languages you select to LOCALE:Catalogs. Kickdown
also runs directly from the archive. html.gadget must be installed in
SYS:Classes/Gadgets/ or lie next to Kickdown. Set the default tool of your
Markdown icons to Kickdown to open them with a double click.

Languages
---------
Kickdown speaks English (built in) and German (Catalogs/deutsch). New
translations: Source/catalogs/Kickdown.cd lists all strings, a translation
is a .ct file as for CatComp or FlexCat.

Contents
--------
 Install              Installer script (English/German)
 Kickdown             the editor
 Catalogs/            translations (German)
 C/mdtohtml           the Shell converter
 Example.md           Markdown example
 Template.html        example page template
 Docs/                documentation (English ReadMe.md, German
                      LiesMich.md)
 Icons/               the archive's icons as GlowIcons and NewIcons (and
                      the classic ones); double click UseGlowIcons,
                      UseNewIcons or UseClassic to switch
 Source/              complete source code (C, cross compiled with
                      bebbo's amiga-gcc and NDK 3.2), including md4c

History
-------
1.0 (03.10.2026)
 - first release

License
-------
MIT License, see LICENSE.
md4c: Copyright (c) 2016-2026 Martin Mitas, MIT License, see
Source/md4c/LICENSE.md.

Deutsch
-------
Kickdown ist ein Markdown-Editor für AmigaOS 3.2 mit Live-HTML-Vorschau,
gebaut mit ReAction; mdtohtml wandelt Markdown-Dateien in der Shell in
HTML-Seiten um. Beide verstehen GitHub-Markdown mit Tabellen,
Durchstreichen, Aufgabenlisten, Autolinks und Fußnoten.

Kickdown spricht Deutsch (Katalog Catalogs/deutsch) und Englisch.
Editor und Vorschau stehen nebeneinander, der Editor hebt die
Markdown-Syntax farbig hervor, die Vorschau folgt beim Schreiben, beide
scrollen gemeinsam. Überschriften erhalten Anker, Links
auf andere .md-Dateien öffnen diese im Editor, Bilder werden relativ zur
Schublade des Dokuments geladen. Export als HTML mit eigenem Template.
Formatierung per Toolbar und Menü Format (Überschrift, fett, kursiv,
unterstrichen, Code, Link, Bild, Listen, Zitat); die Toolbar zeigt
Bilder, Bilder und Text oder nur Text, Knöpfe, die nicht passen, stehen
in einer Aufklappliste. Startfenster beim Programmstart (abschaltbar).
Voraussetzungen: AmigaOS 3.2, html.gadget (Aminet dev/gui/html_gadget.lha)
und AISS für die Toolbar-Bilder. Ausführliche deutsche Dokumentation:
Docs/LiesMich.md. Installation mit dem Installer-Skript Install, das
auch nach den gewünschten Sprachen fragt.

Versionsgeschichte
------------------
1.0 (03.10.2026)
 - erste Veröffentlichung