https://github.com/tumashu/el2org

Convert an emacs-lisp file to org file
https://github.com/tumashu/el2org

Last synced: 15 days ago
JSON representation

Convert an emacs-lisp file to org file

• Host: GitHub
• URL: https://github.com/tumashu/el2org
• Owner: tumashu
• Created: 2017-03-09T04:59:18.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2020-04-08T01:50:09.000Z (almost 5 years ago)
• Last Synced: 2024-11-09T20:37:37.613Z (2 months ago)
• Language: Emacs Lisp
• Homepage:
• Size: 1.64 MB
• Stars: 67
• Watchers: 3
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Note: this file is auto converted from el2org.el by [el2org](https://github.com/tumashu/el2org), please do not edit it by hand!!!

# 目录

1.  [What is el2org](#orgfbaf885)

    1.  [Installation](#orgf6eded7)

    2.  [Configure](#org27e2b16)

    3.  [Usage](#org1242b25)



# What is el2org

el2org is a simple tool, which can convert a emacs-lisp file to org file.

You can write code and document in a elisp file with its help.

               (convert to)                    (export to)

    elisp  -----------------> org (internal) --------------> other formats

Note: el2org.el file may be a good example.

![img](./snapshots/el2org.gif)



## Installation

1.  Config melpa source, please read: 

2.  M-x package-install RET el2org RET

3.  M-x package-install RET ox-gfm RET

    

    ox-gfm is needed by \`el2org-generate-readme', if ox-gfm can not be found,

    ox-md will be used as fallback.



## Configure

    (require 'el2org)

    (require 'ox-gfm)



## Usage

1.  \`el2org-generate-file' can convert an elisp file to other file format

    which org's exporter support.

2.  \`el2org-generate-readme' can generate README.md from elisp's "Commentary"

    section.

3.  \`el2org-generate-html' can generate a html file from current elisp file

    and browse it.

4.  \`el2org-generate-org' can generate a org file from current elisp file.