Markdown Mode Help

Name:	Markdown Mode
Version:	0.1
Last update:	2019-11-27 14:13:04

Introduction

Markdown mode is a mode for the text editor Alpha: it is designed to facilitate editing and rendering of files written with the Markdown markup language (files with .md, .mkd, .mkdn, .mdown, or .markdown extensions).
Once it is in Markdown mode, Alpha displays a menu (called Markdown) in the menu bar. The commands in this menu let you perform tasks such as rendering the current window or a selection, and inserting templates in the document. Markdown mode also provides syntax coloring and file marking.
In order to test the Markdown mode functionality, you can open the Markdown Example file, and then try using the various menu items.

Markdown Menu items

Render Window: This command opens the Markdown Viewer window and displays the rendering of the current file.
Render Selection: This command opens the Markdown Viewer window and displays the rendering of the current selection.
Sections: This submenu contains commands to insert section tags.
Structures: This submenu contains commands to insert list and table templates.
Styles: This submenu contains commands to insert style marks.
Links: This submenu contains commands to create hyperlink tags. They insert the appropriate templates with bullets: use the Tab key to jump to the next bullet. Markdown supports two styles of links: external (pointing to some location specified by an absolute or relative URL) and reference (pointing to some label).
Display Palettes: This commands displays floating menus containing the items found in the submenus above (Sections, Structures, Styles, Links).
Markdown Help: This commands displays the Markdown mode help file.
Display Bindings: Display the bindings currently defined in Markdown mode.
Menu Shortcuts...: Define custom shortcuts for the menu items.

The Mark pop-up menu

The marking procedure creates marks for all the sections of the current document (within the limit set by the Mark Headings To Level preference). The marks are displayed in the Marks popup (📖).
If the Auto Mark checkbox is checked in the preferences, the file is automatically marked at opening.

Key bindings

A whole set of key bindings is available in Markdown mode to trigger the menu commands. Use the command Markdown ↣ Display Bindings to display them or click here.

Markdown Mode preferences

The Preferences… item in the Mode Setup submenu of the Alpha menu allows you to edit specific preferences for the Markdown mode. Click here to open the Markdown Mode preferences panel.
Most variables are standard Alpha preferences (like Auto Mark, Prefix String, Word Break, Word Wrap) or color preferences to customize the coloring schemes.
The Mark Headings To Level preference lets you specify the maximum level of subsections to be marked in the marks popup (1 to 6).

Known problems

Please report any problem or bug you encounter to Alpha's Bug Tracker.

License and Disclaimer

Copyright (c) 2018-2019, Bernard Desgraupes.
All rights reserved.
The Markdown Mode package is free software and distributed under the terms of the new BSD license:
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of Bernard Desgraupes nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BERNARD DESGRAUPES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.