Skip to content

Update and rename README.org to README.md #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Kyonax merged 1 commit into from
Nov 25, 2025
Merged

Update and rename README.org to README.md #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 12 additions & 18 deletions README.org → README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
This package transforms Org files into fully-rendered HTML templates or web-framework components.
/(Currently supports Vue 3 components and static HTML output.)/
This package transforms Org files into fully-rendered HTML templates or web-framework components. *(Currently supports Vue 3 components and static HTML output.)*

The project is still in active development, evolving toward a framework-agnostic engine capable of generating components for any modern frontend stack. The roadmap includes first-class SEO integration and enhanced pipeline controls, a modular toolchain for developers who build fast and think faster.

A lightweight compiler for the ones who use org for blogs, websites, and more. The interface is simple, use ~org2html --help~. More formats, more targets, more power coming soon.
A lightweight compiler for the ones who use Org for blogs, websites, and more. The interface is simple — run `org2html --help`. More formats, more targets, more power coming soon.

* FILE STRUCTURE
#+begin_src txt
> [!IMPORTANT]
> This package is not stable yet, is still under develop, however
Copy link

Copilot AI Nov 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammatical error: 'under develop' should be 'under development'.

Suggested change
> This package is not stable yet, is still under develop, however
> This package is not stable yet, is still under development, however

Copilot uses AI. Check for mistakes.
> if you are interested on support it and contribute you can do it.
Copy link

Copilot AI Nov 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammatical error: 'interested on support it' should be 'interested in supporting it'.

Suggested change
> if you are interested on support it and contribute you can do it.
> if you are interested in supporting it and contributing, you can do it.

Copilot uses AI. Check for mistakes.

# FILE STRUCTURE
```txt
org2html/
├── src/
│ ├── cli/
Expand Down Expand Up @@ -46,18 +49,9 @@ org2html/
├── tsconfig.json
├── README.md
└── .gitignore
#+end_src

* org2html
```

Production-ready Org-mode to HTML parser with Vue 3 component support.

** Installation
#+begin_src bash
## Installation
```bash
npm install -g org2html
#+end_src

> [!IMPORTANT]
> This package is not stable yet, is still under develop, however
> if you are interested on support it and contribute you can do it.
> [https://github.com/kyonax/org2html](Github Repo org2html)
```