AminetAminet
Search:
83349 packages online
About
Recent
Browse
Search
Upload
Setup
Services

text/edit/ami-markdown.lha

Mirror:Random
Showing:ppc-amigaosgeneric
No screenshot available
Short:Edit and view Markdown documents
Author:tyrrell.simon at gmail.com (Simon Tyrrell)
Uploader:tyrrell simon gmail com (Simon Tyrrell)
Type:text/edit
Version:0.8
Requires:dev/mui/MCC_TextEditor-15.55.lha; dev/mui/MCC_BetterString-11.35.lha; dev/mui/MCC_TheBar-26.21.lha; Launch-Handler
Architecture:ppc-amigaos >= 4.1
Distribution:Aminet
Date:2021-01-11
Download:http://aminet.net/text/edit/ami-markdown.lha - View contents
Readme:http://aminet.net/text/edit/ami-markdown.readme
Downloads:117

This is a tool to allow you to edit and view Markdown documents.  It uses a
customised version of md4c at https://github.com/mity/md4c by Martin Mit
available to do the actual conversion of  Markdown to HTML.

## USAGE:

The window consists of two pages; an Editor page and a Settings page.

### Editor:

The Editor page consists of a tool bar and a text editor gadget which is where
the Markdown source code will be shown. The text editor is a subclass of the
[text editor custom class](https://github.com/amiga-mui/texteditor) so all of
its key shortcuts are available too.

#### Toolbar

 * **Load**: Load a Markdown file. Alternatively you can either drag and drop
   a markdown file onto the window.
 * **Save**: Save the contents of the text editor to a file.
 * **Convert**: Convert to HTML and view in a browser. This will save a new
   file with ".html" appended to the name of the markdown file and open it in
   a browser.
 * **Undo**: Undo the latest changes.
 * **Redo**: Redo the latest reverted changes.
 * **Bold**: Make the selected text bold.
 * **Italic**: Make the selected text italic.
 * **Strikethrough**: Strike through the selected text.
 * **Code**: Make the selected text code.
 * **Horizontal Rule**: Insert a Horizontal Rule.
 * **Fenced Code**: Make a fenced code block.
 * **Hyperlink**: Insert a hyperlink. This will open a new window where you
   can enter the link text and address. 
 * **Image**: Insert an image. This will open a new window where you can enter
   the image path, its alternative text and an optional title. 
 * **Table**: Insert a table. This will open a new window where you can enter
   the number of rows and columns that you require. Also there is an
   *Alignments* string gadget where you can specify the alignment for each
   column. 
   By default, each column is left-aligned, however you can alter that here.
   The string here will be read where the first character defines the
   alignment for the first column, the second character for the second column,
   *etc.* 
    * *l* will make the column left-aligned, 
    * *r* will make the column right-aligned
    * *c* will make the column centre-aligned.

If the *Alignments* is empty or has fewer characters than the number of
specified columns, the remaining columns will default to being left-aligned.
For example *crlc* would specify that the first four columns of the table
would be centre-, right-, left- and centre-aligned respectively.
 
### Settings:

On this page you can configure some of the options for converting the md4c
Markdown to HTML. For more information on these, view the
[md4c documentation](https://github.com/mity/md4c) 

## FUTURE:

 * Getting the buttons to become selected for given bits of text, e.g. the
   bold button being highlighted when the cursor is in a piece of bold text,
   etc. 
 * Syntax highlighting would be nice too. 
 * Adding more elements to the md4c Markdown to HTML conversion code such as
   definition lists, footnotes, *etc.* This would then get added to md4c via
   pull requests.
 * The ability to save and load customised conversion settings.
 * Get the *Convert* function to re-use an existing browser window rather than
   launch a new one each time.

Any other ideas are welcome. :-)

## CHANGELOG

### 0.8 - (10/01/2021)
 * Moved to using TheBar to give a graphical toolbar along with many more
   functions.
 * Added Undo, Redo, Strikethrough, Code, Fenced Code Blocks, Horizontal
   Rule, Table, Image and Link functions
	
### 0.5 - (07/01/2021):
 * Changed from using HTMLview to using Launch-Handler which comes with OS4.
 * Added the settings page to allow configuration of the Markdown to HTML
   conversion settings. 
 * Added a (very!) :-)) rudimentary set of buttons on the toolbar to allow the
   setting of bold, italic and code sections. 
 * Added a test Markdown file.
 * Bug fixes.

### 0.1 - (05/01/2021):
 * Initial release

## LICENSE:

The code is available under the MIT license. The md4c parts are copyright
Martin Mit and the rest is copyright (c) 2021  by Simon Tyrrell. The
emoticon_bigsmile image is copyright to Martin Merz, go to
http://www.masonicons.info for more information and to get his awesome
artwork.


Contents of text/edit/ami-markdown.lha
PERMISSION  UID  GID    PACKED    SIZE  RATIO METHOD CRC     STAMP     NAME
---------- ----------- ------- ------- ------ ---------- ------------ ----------
[unknown]               380818 1239647  30.7% -lh5- a493 Jan 10 19:16 ami-markdown/AmiMarkdown
[unknown]                11334   17334  65.4% -lh5- b0c5 Jan 10 19:15 ami-markdown/AmiMarkdown.cbp.info
[unknown]               380818 1239647  30.7% -lh5- a493 Jan 10 19:16 ami-markdown/AmiMarkdown.debug
[unknown]                10423   11904  87.6% -lh5- 1d48 Jan 10 19:15 ami-markdown/AmiMarkdown.info
[unknown]                  768     768 100.0% -lh0- d7c5 Jan 10 19:15 ami-markdown/emoticon_bigsmile
[unknown]                  628    1070  58.7% -lh5- 544a Jan 10 19:15 ami-markdown/LICENSE
[unknown]                  847    3374  25.1% -lh5- 1bb3 Jan 10 19:16 ami-markdown/Makefile
[unknown]                  389     661  58.9% -lh5- 4fe2 Jan 10 19:15 ami-markdown/md4c/.gitignore
[unknown]                  601    1156  52.0% -lh5- 47df Jan 10 19:15 ami-markdown/md4c/.travis.yml
[unknown]                  340     560  60.7% -lh5- e0c8 Jan 10 19:15 ami-markdown/md4c/appveyor.yml
[unknown]                 4786   12375  38.7% -lh5- e92c Jan 10 19:15 ami-markdown/md4c/CHANGELOG.md
[unknown]                  802    2040  39.3% -lh5- 5b01 Jan 10 19:15 ami-markdown/md4c/CMakeLists.txt
[unknown]                   74      81  91.4% -lh5- 455e Jan 10 19:15 ami-markdown/md4c/codecov.yml
[unknown]                  115     178  64.6% -lh5- ea08 Jan 10 19:15 ami-markdown/md4c/compile
[unknown]                  669    1096  61.0% -lh5- 693c Jan 10 19:15 ami-markdown/md4c/LICENSE.md
[unknown]               119872  364009  32.9% -lh5- 547d Jan 10 19:15 ami-markdown/md4c/md
[unknown]                  304     576  52.8% -lh5- 9305 Jan 10 19:15 ami-markdown/md4c/md2html/CMakeLists.txt
[unknown]                 2253    8313  27.1% -lh5- cfce Jan 10 19:15 ami-markdown/md4c/md2html/cmdline.c
[unknown]                 2492    6155  40.5% -lh5- c3ff Jan 10 19:15 ami-markdown/md4c/md2html/cmdline.h
[unknown]                  774    1746  44.3% -lh5- d696 Jan 10 19:15 ami-markdown/md4c/md2html/md2html.1
[unknown]                 5192   12578  41.3% -lh5- 48d4 Jan 10 19:15 ami-markdown/md4c/README.md
[unknown]                 1402    4351  32.2% -lh5- 6229 Jan 10 19:15 ami-markdown/md4c/scripts/build_folding_map.py
[unknown]                  697    1781  39.1% -lh5- fb87 Jan 10 19:15 ami-markdown/md4c/scripts/build_punct_map.py
[unknown]                  690    1750  39.4% -lh5- 9294 Jan 10 19:15 ami-markdown/md4c/scripts/build_whitespace_map.py
[unknown]                  648    1488  43.5% -lh5- 2164 Jan 10 19:15 ami-markdown/md4c/scripts/coverity.sh
[unknown]                  597    2160  27.6% -lh5- 3884 Jan 10 19:15 ami-markdown/md4c/scripts/run-tests.sh
[unknown]                15232   82810  18.4% -lh5- c6ec Jan 10 19:15 ami-markdown/md4c/scripts/unicode/CaseFolding.txt
[unknown]                55778  259503  21.5% -lh5- 664b Jan 10 19:15 ami-markdown/md4c/scripts/unicode/DerivedGeneralCategory.txt
[unknown]                  543    1697  32.0% -lh5- e814 Jan 10 19:15 ami-markdown/md4c/src/CMakeLists.txt
[unknown]                14197   74111  19.2% -lh5- b9d1 Jan 10 19:15 ami-markdown/md4c/src/entity.c
[unknown]                  897    1573  57.0% -lh5- e564 Jan 10 19:15 ami-markdown/md4c/src/entity.h
[unknown]                27823   84468  32.9% -lh5- 29a2 Jan 10 19:16 ami-markdown/md4c/src/entity.o
[unknown]                 5218   19734  26.4% -lh5- a9ff Jan 10 19:15 ami-markdown/md4c/src/md4c-html.c
[unknown]                 1289    2508  51.4% -lh5- 8ce1 Jan 10 19:15 ami-markdown/md4c/src/md4c-html.h
[unknown]                11839   35976  32.9% -lh5- 3f19 Jan 10 19:16 ami-markdown/md4c/src/md4c-html.o
[unknown]                  227     379  59.9% -lh5- 0553 Jan 10 19:15 ami-markdown/md4c/src/md4c-html.pc.in
[unknown]                51630  220990  23.4% -lh5- 1086 Jan 10 19:15 ami-markdown/md4c/src/md4c.c
[unknown]                 5516   15458  35.7% -lh5- a257 Jan 10 19:15 ami-markdown/md4c/src/md4c.h
[unknown]                66225  224484  29.5% -lh5- 6206 Jan 10 19:16 ami-markdown/md4c/src/md4c.o
[unknown]                  232     365  63.6% -lh5- 29ff Jan 10 19:15 ami-markdown/md4c/src/md4c.pc.in
[unknown]                   70     101  69.3% -lh5- c449 Jan 10 19:15 ami-markdown/md4c/test.html
[unknown]                   49      55  89.1% -lh5- 1487 Jan 10 19:15 ami-markdown/md4c/test.md
[unknown]                  548    1372  39.9% -lh5- 20f4 Jan 10 19:15 ami-markdown/md4c/test/cmark.py
[unknown]                 2679   10295  26.0% -lh5- 137a Jan 10 19:15 ami-markdown/md4c/test/coverage.txt
[unknown]                  251     424  59.2% -lh5- 5be8 Jan 10 19:15 ami-markdown/md4c/test/fuzz-input/commonmark.md
[unknown]                   99     133  74.4% -lh5- 6521 Jan 10 19:15 ami-markdown/md4c/test/fuzz-input/gfm.md
[unknown]                   27      30  90.0% -lh5- c02a Jan 10 19:15 ami-markdown/md4c/test/fuzz-input/latex-math.md
[unknown]                   24      24 100.0% -lh0- ab8f Jan 10 19:15 ami-markdown/md4c/test/fuzz-input/wiki.md
[unknown]                  504    1136  44.4% -lh5- f43a Jan 10 19:15 ami-markdown/md4c/test/latex-math.txt
[unknown]                 1319    2791  47.3% -lh5- 6e4d Jan 10 19:15 ami-markdown/md4c/test/LICENSE
[unknown]                 2044    6508  31.4% -lh5- a069 Jan 10 19:15 ami-markdown/md4c/test/normalize.py
[unknown]                 1597    4905  32.6% -lh5- f288 Jan 10 19:15 ami-markdown/md4c/test/pathological_tests.py
[unknown]                  538    1511  35.6% -lh5- 0745 Jan 10 19:15 ami-markdown/md4c/test/permissive-email-autolinks.txt
[unknown]                  853    2855  29.9% -lh5- 28f9 Jan 10 19:15 ami-markdown/md4c/test/permissive-url-autolinks.txt
[unknown]                 1270    4049  31.4% -lh5- 02a5 Jan 10 19:15 ami-markdown/md4c/test/permissive-www-autolinks.txt
[unknown]                48672  202651  24.0% -lh5- cb9e Jan 10 19:15 ami-markdown/md4c/test/spec.txt
[unknown]                 1842    5924  31.1% -lh5- 2ef9 Jan 10 19:15 ami-markdown/md4c/test/spec_tests.py
[unknown]                  595    1677  35.5% -lh5- 4509 Jan 10 19:15 ami-markdown/md4c/test/strikethrough.txt
[unknown]                 1638    7641  21.4% -lh5- 4dd5 Jan 10 19:15 ami-markdown/md4c/test/tables.txt
[unknown]                  502    3590  14.0% -lh5- 4719 Jan 10 19:15 ami-markdown/md4c/test/tasklists.txt
[unknown]                  401     983  40.8% -lh5- e967 Jan 10 19:15 ami-markdown/md4c/test/underline.txt
[unknown]                 1184    5994  19.8% -lh5- 6e98 Jan 10 19:15 ami-markdown/md4c/test/wiki-links.txt
[unknown]                 1918    4527  42.4% -lh5- 7b68 Jan 10 19:15 ami-markdown/readme.md
[unknown]                  470     929  50.6% -lh5- dce0 Jan 10 19:15 ami-markdown/test.md
---------- ----------- ------- ------- ------ ---------- ------------ ----------
 Total        64 files 1254073 4230959  29.6%            Jan 12 04:53

Aminet © 1992-2021 Urban Müller and the Aminet team. Aminet contact address: <aminetaminet net>