Kickdown 1.1

Markdown editor with HTML preview

Short:        Markdown editor with HTML preview
Author:       André Gewert <agewert@ubergeek.de>
Uploader:     André Gewert <agewert ubergeek de>
Type:         text/edit
Version:      1.1
Requires:     AmigaOS 3.2, dev/gui/html_gadget.lha (1.2), 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
                      README.de.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.1 (17.10.2026)
 - printing (Project/Print, Amiga-P, toolbar): to the printer through
   printer.device (graphics, the fonts of the preview; on the default printer,
   with the resolution of its settings), as PostScript to a file, PRT:, PS:
   (TurboPrint) or a device, or as PDF; paper size, margins, font and size,
   page numbers, background colours, page range, copies; PostScript level 2 or
   1; pictures are compressed (LZW, JPEG files as they are, not in level 1)
   and can be scaled down to 600-75 dpi; a window shows the progress and can
   stop it; needs html_gadget 1.2; with TurboPrint, Kickdown prints through
   PostScript level 2 to PS:
 - the preview shows Markdown as GitHub does: thin lines in tables,
   grey backgrounds for code, a bar for quotes (also when printing);
   needs html_gadget 1.2
 - new setting (Preview page, tool type FITIMAGES, off by default): big
   pictures are scaled down to the width of the preview and of the
   printed page; needs html_gadget 1.2
 - menu check marks keep their state after iconifying and after changes
   in the settings window
 - status line and find window show underscores in file names and texts
   (they were taken for a shortcut mark)
 - synchronised scrolling: the other side follows when scrolling pauses
   for a moment, so scrolling with the mouse wheel is faster
 - NewIcons drawn in the style of the NewIcons package (isometric, its
   palette, objects on a platform); selected they show a changed picture
   (open drawer, dog ear, ...) instead of a darker one
 - Docs: README.md and README.de.md keep their names (were ReadMe.md and
   LiesMich.md), so the links between them and to pictures work
 - toolbar: faster start; the AISS images for pressed buttons are no
   longer loaded (pressed buttons look recessed), and the formatting
   buttons are hidden by default and loaded when first shown (tool type
   FORMATBUTTONS replaces NOFORMATBUTTONS)
 - settings window: the category list is as wide as its longest entry,
   a bar between list and page adjusts the split
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/README.de.md. Installation mit dem Installer-Skript Install, das
auch nach den gewünschten Sprachen fragt.

Versionsgeschichte
------------------
1.1 (17.10.2026)
 - Drucken (Projekt/Drucken, Amiga-P, Toolbar): auf den Drucker über
   printer.device (Grafik, mit den Schriften der Vorschau; auf dem
   Standarddrucker, mit der Auflösung aus seinen Einstellungen), als
   PostScript in eine Datei, nach PRT:, PS: (TurboPrint) oder an ein Gerät,
   oder als PDF; Papierformat, Ränder, Schrift und Größe, Seitenzahlen,
   Hintergrundfarben, Seitenbereich, Kopien; PostScript Level 2 oder 1; Bilder
   werden komprimiert (LZW, JPEG-Dateien unverändert, nicht bei Level 1) und
   lassen sich auf 600-75 dpi verkleinern; ein Fenster zeigt den Fortschritt
   und kann abbrechen; braucht html_gadget 1.2; mit TurboPrint druckt Kickdown
   über PostScript Level 2 nach PS:
 - die Vorschau zeigt Markdown wie GitHub: dünne Linien in Tabellen,
   graue Hintergründe für Code, ein Balken bei Zitaten (auch beim
   Drucken); braucht html_gadget 1.2
 - neue Einstellung (Seite Vorschau, Tooltype FITIMAGES, abgeschaltet):
   große Bilder werden auf die Breite der Vorschau und der gedruckten
   Seite verkleinert; braucht html_gadget 1.2
 - Menü-Häkchen behalten ihren Zustand nach dem Ikonifizieren und nach
   Änderungen im Einstellungsfenster
 - Statuszeile und Suchfenster zeigen Unterstriche in Dateinamen und
   Texten (sie galten als Markierung eines Tastenkürzels)
 - synchrones Scrollen: die andere Seite folgt, sobald das Scrollen kurz
   ruht, so scrollt das Mausrad schneller
 - NewIcons im Stil des NewIcons-Pakets gezeichnet (isometrisch, seine
   Palette, Objekte auf einem Sockel); ausgewählt zeigen sie ein geändertes
   Bild (offene Schublade, Eselsohr ...) statt eines dunkleren
 - Docs: README.md und README.de.md behalten ihre Namen (bisher ReadMe.md
   und LiesMich.md), so funktionieren die Links untereinander und zu Bildern
 - Toolbar: schnellerer Start; die AISS-Bilder für gedrückte Knöpfe
   werden nicht mehr geladen (gedrückte Knöpfe erscheinen vertieft), und
   die Formatierungsknöpfe sind zunächst ausgeblendet und werden erst
   beim ersten Einblenden geladen (Tooltype FORMATBUTTONS statt
   NOFORMATBUTTONS)
 - Einstellungsfenster: die Kategorienliste ist so breit wie ihr längster
   Eintrag, ein Balken zwischen Liste und Seite verschiebt die Aufteilung
1.0 (03.10.2026)
 - erste Veröffentlichung