Table of Contents

• Description
• Install
• Usage
• Customize
• Information
  • Community
  • Contribution
  • Migration
  • License
  • Author
  • Contributors

Description

Zenn flavored markdown backend for org export engine.

Install

Sample install code using leaf.el.

(leaf ox-zenn :ensure t)

Usage

Customize

Headline offset

If h1 is used as a title, and # is converted to h1 and ## is converted to h2, you want to output the top level heading * in org as ##.

You can do this with customizing gfm-headline-offset. If you set this variable to 1, ox-zenn will convert * to ## and ** to ###.

• Global config

  (setq gfm-headline-offset 1)
      

• Org document

  #+options: headline-offset:1
      

Frontmatter

last_modified property

ox-zenn inserts last_modified property by default. If you want to not inserting this, please set org-zenn-with-last-modified to nil (by global effect) or set last-modified option to nil (per org document).

• Global config

  (setq org-zenn-with-last-modified nil)
      

• Org document

  #+options: last-modified:nil
      

Known issues

Column Groups

Now, we cannot transform tables using column groups feature.

| Head | Head | Head      |
|------+------+-----------|
| Text | Text | Teeeeeext |
| Text | Text | Text      |

|   | Head | Head | Head      |
|---+------+------+-----------|
| / | <    | >    | <>        |
|   | Text | Text | Teeeeeext |
|   | Text | Text | Text      |

Transform into

| Head | Head | Head      |
| ---- | ---- | --------- |
| Text | Text | Teeeeeext |
| Text | Text | Text      |

| Head | Head || Head |
| --- | --- | --- |
| Text | Text || Teeeeeext |
| Text | Text || Text |

Borders in tables

Now, we cannot transform tables using boarders in tables.

| Head | Head | Head      |
|------+------+-----------|
| Text | Text | Teeeeeext |
| Text | Text | Text      |
|------+------+-----------|
| Text | Text | Text      |
| Text | Text | Text      |

Transform into

| Head | Head | Head      |
| ---- | ---- | --------- |
| Text | Text | Teeeeeext |
| Text | Text | Text      |
| Text | Text | Text      |
| Text | Text | Text      |

Information

Community

Any feedback or suggestions are welcome!

You can use github issues, but you can also use Slack if you want a more casual conversation.

Contribution

We welcome PR!

Require tools for testing

• keg

  cd ~/
  hub clone conao3/keg .keg
  export PATH="$HOME/.keg/bin:$PATH"
      

Running test

Below operation flow is recommended.

git branch [feature-branch]       # Create branch named [feature-branch]
git checkout [feature-branch]     # Checkout branch named [feature-branch]

# <edit loop>
emacs ox-zenn.el             # Edit something you want

make test                         # Test ox-zenn
git commit -am "brabra"           # Commit (auto-run test before commit)
# </edit loop>

hub fork                          # Create fork at GitHub
git push [user] [feature-branch]  # Push feature-branch to your fork
hub pull-request                  # Create pull-request

Migration

License

General Public License Version 3 (GPLv3)
Copyright (c) Naoya Yamashita - https://conao3.com
https://github.com/conao3/ox-zenn.el/blob/master/LICENSE

Author

• Naoya Yamashita (conao3)

Contributors