Скачать uniorg - скачать исходный код uniorg

uniorg

AI Исходный код

[email protected]

Скачать

UniOrg является точным синтаквиком Org-Mode, совместимым с унифицированной экосистемой.

Почему

Я хочу опубликовать свой BrainDump из заметок Org-Mode. Ни один из проборителей, которые я пробовал, не обеспечил достаточную точность.

Uniorg стремится к точности анализа, а не для скорости или простоты написания анализатора.

UniOrg следует за синтаксисом орг и API org Element. Он в значительной степени рисует из org-element.el, что означает, что Uniorg видит файлы орг так же, как и Org-Mode. Код полон режимов, но именно это именно так инициатирует файлы Org-Mode.

Тем не менее, есть несколько преднамеренных отклонений от Org-Mode, которые делают Uniorg более приятным или легче работать.

Демо

https://braindump.rasen.dev/uniorg - Играйте с тем, как Uniorg анализирует и переводит файлы орг.
Примеры/Next-Blog-Starter-пример блога Next.js с Uniorg (https://org-blog-starter.vercel.app).
Примеры/org-braindump-веб-сайт unioRg next.js, адаптированный для публикации взаимосвязанной коллекции заметок (https://org-braindump.vercel.app).
Примеры/пример - простой инструмент CLI для преобразования файлов ORG в HTML.

Статус

Uniorg успешно анализирует большую часть синтаксиса ORG. Тем не менее, есть несколько мест, которые я еще не закончил:

InlineTask
Babel-Call, Inline-Babel-Call, Inline-Src-Block
динамический блок
Target, радио-целевой
макро
переключатели и параметры в SRC-блоке и примере блока
Потедать/предупреждение реквизит в временной метке

Остальная часть синтаксиса должна работать нормально и точно так же, как и в EMAC (включая сложное гнездование списка, ссылки, ящики, записи часов, латекс и т. Д.). Если вы хотите помочь с предметами выше, grep parser.ts для TODO: .

Пакеты

Этот репозиторий содержит следующие пакеты:

uniorg - определения типового типового дерева синтаксиса UniORG
uniorg-parse -файлы Parse Org-Mode к синтаксисам UniOrg
uniorg-stringify -Stringify uniorg Синтаксис дерево к строке орг-режима
uniorg-rehype - преобразовать синтаксические деревья UniOrg
uniorg-extract-keywords -хранить ключевые слова Org-Mode для VFILE
uniorg-attach -конвертировать attachment: ссылки на file: ссылки
uniorg-slug -добавьте якоря к заголовкам, используя алгоритм GitHub
orgast-util-to-string -утилита, чтобы получить простое текстовое содержание узла
orgast-util-visit-ids

объединенный

UniOrg совместим с унифицированной экосистемой, поэтому вы можете воспользоваться многими существующими плагинами.

Например, вот как вы преобразуете орг-режим в HTML.

 import { unified } from 'unified' ;
import parse from 'uniorg-parse' ;
import uniorg2rehype from 'uniorg-rehype' ;
import stringify from 'rehype-stringify' ;

const processor = unified ( ) . use ( parse ) . use ( uniorg2rehype ) . use ( stringify ) ;

processor
  . process ( `* org-mode examplen your text goes here` )
  . then ( ( file ) => console . log ( file . value ) ) ;

Плагины для выделения синтаксиса кода (rehype-highlight, @mapbox/rehype-prism) и латексное форматирование (Rehype-Katex, Rehype-Mathjax) должны работать из коробки:

 import { unified } from 'unified' ;
import parse from 'uniorg-parse' ;
import uniorg2rehype from 'uniorg-rehype' ;
import highlight from 'rehype-highlight' ;
import katex from 'rehype-katex' ;
import stringify from 'rehype-stringify' ;

const processor = unified ( )
  . use ( parse )
  . use ( uniorg2rehype )
  . use ( highlight )
  . use ( katex )
  . use ( stringify ) ;

processor
  . process (
    `* org-mode example
When $a ne 0$, there are two solutions to (ax^2 + bx + c = 0) and they are
$$x = {-b pm sqrt{b^2-4ac} over 2a}.$$

#+begin_src js
console.log('uniorg is cool!');
#+end_src
`
  )
  . then ( ( file ) => console . log ( file . value ) ) ;