https://github.com/klafyvel/norganic

The solvent-free Norg compiler.
https://github.com/klafyvel/norganic

markup markup-converter markup-language neorg org-mode pandoc

Last synced: about 1 month ago
JSON representation

The solvent-free Norg compiler.

• Host: GitHub
• URL: https://github.com/klafyvel/norganic
• Owner: Klafyvel
• License: mit
• Created: 2023-03-22T08:16:58.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-28T07:38:03.000Z (over 1 year ago)
• Last Synced: 2024-05-19T09:07:01.319Z (7 months ago)
• Topics: markup, markup-converter, markup-language, neorg, org-mode, pandoc
• Language: Julia
• Homepage:
• Size: 20.5 KB
• Stars: 19
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Norganic 

> Your solvent-free Norg compiler.

`norganic` is a frontend to [Norg.jl](https://github.com/Klafyvel/Norg.jl/), a [norg](https://github.com/nvim-neorg/norg-specs/) parser. It allows compiling `.norg` files to various target formats.

Install `norganic` now by downloading the [latest version](https://github.com/Klafyvel/norganic/releases/latest). Alternatively, see the [compile from sources](#compile-from-sources) section.

## Usage

`norganic` input/output defaults to `stdin` and `stdout`. You can decide to specify input/output files using `--input`/`--output`.

```bash

norganic html --input 1.0-specification.norg --output 1.0-specification.html

norganic json --input 1.0-specification.norg | pandoc -f json -t html -o 1.0-specification.html

```

## Compile from sources

You need Julia on your operating system. If you don't already have Julia installed, consider using [juliaup](https://github.com/JuliaLang/juliaup).

You can then use the provided `Makefile`.

```bash

make # Compile the app to build/norganic

make archive # Create a tarball for the app

make comonicon # Create a launchable script in ~/.julia/bin

make compost # Compost the repository

```