https://github.com/Fuco1/org-pretty-table

Replace org-table characters with box-drawing unicode glyphs.
https://github.com/Fuco1/org-pretty-table

Last synced: 3 months ago
JSON representation

Replace org-table characters with box-drawing unicode glyphs.

• Host: GitHub
• URL: https://github.com/Fuco1/org-pretty-table
• Owner: Fuco1
• Created: 2013-11-29T15:10:58.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2023-03-19T14:52:44.000Z (over 1 year ago)
• Last Synced: 2024-05-01T22:56:58.333Z (6 months ago)
• Language: Emacs Lisp
• Size: 39.1 KB
• Stars: 101
• Watchers: 6
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# org-pretty-table

Draw pretty unicode tables in `org-mode` and `orgtbl-mode`.

Very experimental.

![example](https://pbs.twimg.com/media/FqexCG-WYAA9x_X?format=png&name=large)

# Usage

Enable the `org-pretty-table-mode` in an org buffer and it will

replace the ASCII table borders with beautiful unicode ones.  The

replacement is *only visual* (using [display text properties][props]),

nothing in your file is actually changed.  The buffer and the file

saved to disc still contains the original ASCII characters (which it

must since that's what org uses for table detection).

You can customize `org-pretty-table-charset` to change the border

characters.  This mode comes with two built-in "themes", single

horizontal lines and double horizontal lines.  See `M-x

customize-variable RET org-pretty-table-charset RET`.

# Installation

This package is not yet distributed through package archives and you have to install it manually.

1. Download the `org-pretty-table.el` file into some folder in your hard drive (for example `~/.emacs.d/site-lisp`).

2. Put the following code into your `~/.emacs.d/init.el` or `~/.emacs` file:

``` emacs-lisp

(progn

  (add-to-list 'load-path "~/.emacs.d/site-lisp")

  (require 'org-pretty-table)

  (add-hook 'org-mode-hook (lambda () (org-pretty-table-mode))))

```

3. Evaluate the `progn` block by putting the point on the `progn` and calling `C-M-x` (`M-x eval-defun`).  If unsure, you can also simply restart Emacs.

4. Open an org-mode file.  Calling `M-: org-pretty-table-mode RET` should print `1` in the minibuffer.  You're done!

# Development

Use Eask to install dependencies:

``` shell

eask install-deps --dev

```

Run tests with

``` shell

eask test buttercup

```

[props]: https://www.gnu.org/software/emacs/manual/html_node/elisp/Special-Properties.html