uniorg-util v0.2.1
This program converts your Org Mode documents into HTML + metadata.\ Outputs to both JSON and EDN formats.
It relies heavily on [https://github.com/rasendubi]'s very accurate Org Mode parser, [https://github.com/rasendubi/uniorg].
** Installation:
Install with npm. #+begin_src shell npm install uniorg-util #+end_src
Or install with yarn. #+begin_src shell yarn add uniorg-util #+end_src
** Usage: Outputs JSON by default. #+begin_src shell npm run uniorg-util OPTIONS #+end_src
#+begin_src shell yarn uniorg-util OPTIONS #+end_src
By default it will process everything in the current directory.
Options: #+begin_example -i, --input DIR . Directory to read from -o, --output DIR . Directory to output to -e, --edn Output files as EDN instead of JSON -m, --manifest NAME false Create a list of all-files processed -h, --help #+end_example
If installed globally, just run: #+begin_src shell uniorg-util OPTIONS #+end_src
** Example:
*** Input:
#+begin_src org #+title: Here's a title #+subtitle: And more headers #+date: 2021-04-15 #+tags: it also has an id #+author: Christian Westrom #+id: test-1
- Here's some stuff
:PROPERTIES:
:id: Here's a drawer of stuff
:END:
- Here's more stuff
** DONE Make example CLOSED: 2021-06-20 Sun 23:10 #+end_src
*** Output
/Note: Formatted nicely just for show./\\
Outputs as one line.
#+begin_src edn{:content "Here's some stuff
** TODO:
- Figure out why I can't run the tool after installing.
- Automate pushing releases.
- Try adding a watch function.\ A function updates the data by watching a directory.
** Development:
Install dependencies: #+begin_src shell yarn install #+end_src
Run a repl with tests: #+begin_src shell yarn watch:test #+end_src
Run a repl without tests: #+begin_src shell yarn watch #+end_src
Build the script: #+begin_src shell yarn build #+end_src
Run tests: #+begin_src shell yarn test #+end_src
License This program converts your Org Mode documents into HTML + metadata.\ Copyright © 2021 Christian Westrom
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.