Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 2.36 KB

README.org

File metadata and controls

64 lines (45 loc) · 2.36 KB

https://melpa.org/packages/trope-mode-badge.svg

Trope-Mode

A major mode for writing the unnamed markup language used for the website TV Tropes, which should be put in “.trp” or “.trope” files. This package aims to be fast, use as little dependencies as possible, and to make it easier to write pages for the website, not to use as a standalone markup format.

./assets/Trope-Mode-demo_2.gif

Installation

This package is now available in the MELPA repository. To access it, make sure to add MELPA to your package sources (some package managers such as elpaca have it by default). Then, use M-x package-install and then the package name or use the following declaration in your init.el:

(use-package trope-mode :ensure t :defer t)

And the trope should be available on the next restart for properly named files or with M-x trope-mode.

If you do not want to install it using a package manager, you can also use the package by getting the source code directly. To use this package, clone the project using git to a directory of your choice. Then, in your init.el file add this code:

(add-to-list 'load-path "path/to/trope-mode")
(require 'trope-mode)

The path should be to the project folder, not the file trope-mode.el.

Functions

Besides font-locking, this package also provides functions and keybindings to speed up writing.

FunctionKeybindingDefinition
trope-mode-italicize-regionC-c ; iItalicize selected region
trope-mode-bold-regionC-c ; bBold selected region
trope-mode-monospace-regionC-c ; mMonospace selected region
trope-mode-create-folderC-c ’ fCreate a folder
trope-mode-create-noteC-c ’ nCreate a note
trope-mode-create-quoteblockC-c ’ qCreate a quote block
trope-mode-create-labelnoteC-c ’ lCreate a labelnote

Suggestions and Contributions

This is a new project with many kinks to iron out, so opening issues and pull requests is welcomed. Please feel free to write communicate any issues in the user experience or any suggestions for improvements.