https://github.com/haxscramper/haxorg_nim

https://github.com/haxscramper/haxorg_nim

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/haxscramper/haxorg_nim
• Owner: haxscramper
• Created: 2020-12-23T17:15:32.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-15T09:48:14.000Z (about 2 years ago)
• Last Synced: 2023-03-10T09:37:19.257Z (almost 2 years ago)
• Language: Nim
• Size: 1.31 MB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.org

Awesome Lists containing this project

README

        
Nim parser for org-mode

NOTE: work-in-progress

[[https://orgmode.org/][org-mode]] parser, compiler, and exporter in nim. Several custom extensions

to syntax are supported, specifiaclly geared towards use in documentation

generator for [[https://github.com/haxscramper/haxdoc][haxdoc]].

# This is a placeholder readme title - commented out for now, untill all

# features listed could really be delivered. You can treat this as a

# PR-oriented todo list if you wish.

# Org-mode is the most reasonable markup language , an

# I mean really . But it is really adopted only inside of

# emacs. Why? Because .

# Will this project change it? I'm not sure, but it is worth a try at least.

# Thanks to unparallel metaprogramming capabilities of nim-lang and support

# for multiple backends it is easily possible to make it accessible to

# everyone - from low-level C interfaces  to js

# compilation . Thanks to awesome numpy project 

# seamless python integration is also possible. If you need to write wrappers

# for your particular language you can see machine-readable description of C

# API . Also you can just run parser and export org-mode AST to various

# formats such as , ,  or even .

# If you are interested on how all of this is possible from single codebase

# with minimal effort - here is an article .

# Installation is very simple - standalone binary, only  in size. Various distributions are

# provided, ranging from fully-featured with spellchecker, guile interpreter

# built-in , to minimalistic one, with only

# converter functionality.

* TODO Planned features

  :PROPERTIES:

  :CREATED:  <2021-01-13 Wed 15:04>

  :END:

** TODO Base org-mode parser [0/3]

   :PROPERTIES:

   :CREATED:  <2021-01-13 Wed 15:04>

   :END:

- [ ] Support for parsing base org-mode format

- [ ] Documentat syntax extensions

- [ ] Porting features from other markup languages

  - [ ] Partial support for markdown syntax elements

    - [ ] Links

    - [ ] Headings

    - [ ] Code block format

    - [ ] Key-value pairs for metadata

  - [ ] emacs file variables

** TODO Code runner implementation

   :PROPERTIES:

   :CREATED:  <2021-01-13 Wed 15:05>

   :END:

Execution of code blocks in text

** TODO Exported backends [0/1]

   :PROPERTIES:

   :CREATED:  <2021-01-13 Wed 15:06>

   :END:

- [-] Base

  - [ ] Html

  - [ ] Latex

  - [X] Machine-readable output like json

    - [X] 

** TODO Different backends support

   :PROPERTIES:

   :CREATED:  <2021-02-04 Thu 13:53>

   :END:

- [ ] C, C++

  - [ ] Pure-C bindings

- [ ] JS for interactive demo

- [ ] nimscript - use as asternative to ~docopt~ formatting.