norgkyll

easily generate static sites while being compatible with your norg notes

#css #neorg #neovim #norg #static-site-generator #typescript #astrojs #astrojs-template #hakyll #jekyll

NorgKyll

Welcome aboard! NorgKyll is your go-to tool for converting Neorg files (.norg) into beautiful, fully-functional static websites. Whether you're a Markdown veteran or new to structured text, NorgKyll bridges the gap between simplicity and power.

Installation

To install it is very simple, just type the command npm i -g norgkyll

╭─ 💁 charon at 💻 DESKTOP-27DNBRN in 📁 ~ on (🌿 main •39 ⌀163 ✗)
╰λ npm i -g norgkyll

added 48 packages, and changed 1 package in 12s

5 packages are looking for funding
  run `npm fund` for details

What is Neorg? 🤔

Think of Neorg as a supercharged Markdown. It’s a markup format designed for note-taking, life management, and pretty much anything else you can express in plaintext. Neorg works seamlessly with Neovim, making it a breeze to create, edit, and organize your notes.

Neorg in a Nutshell

Basic Syntax

Any plain text is allowed. Example: "This is my note!"

Inline Markup

Style your text easily: bold, italic, underline, superscript, subscript, etc.

Lists

Create unordered or ordered lists with simple syntax.

Headings and Nesting

Use asterisks for headings, and indent for nested content.

Tasks (TODOs)

Turn lists into actionable tasks with TODO states: undone, done, urgent, on hold, etc.

What is NorgKyll? 🌟

While Neorg helps you create structured content, NorgKyll lets you share it by generating a static website from your .norg files.

NorgKyll CLI ⚙️

Usage: norgkyll <command>

Commands

init: initializes a project with .norg templates and css

build: Generate the static site based on your .norg files.

clean: Remove the output directory and start fresh.

help: Show help and usage instructions.

How to Use

Create a .norg file
Write your notes, tasks, or documentation in Neorg format.
Run the CLI
Use norgkyll build to generate your static site.
Serve or Share
Your .norg files are now sleek, shareable HTML pages.

📋 Tasks

Add link support
Add a prompt in the cli asking for the website name
Add support for tables
Add table of contents support
Improve task renderer
fix the bold text formatting that is showing the strong tag
Start creating documentation
Add support for neorg image

Why NorgKyll? 🚀

Effortless Conversion: Turn .norg into HTML without breaking a sweat.
Custom Styling: Personalize your site with CSS.
Dynamic TODOs: Keep your tasks organized and actionable on the generated site.

Get Started Today

Transform your notes into something spectacular with NorgKyll. Whether it’s project documentation, a personal blog, or keeping track of tasks, your ideas deserve to shine! 🌟