diff options
| -rw-r--r-- | README.md | 28 | ||||
| -rw-r--r-- | README.org | 22 |
2 files changed, 28 insertions, 22 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..28b0704 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# README + +[org-live](https://org.cmc.pub) is a live environment for writing and +editing [org-mode](https://orgmode.org/). + +## Functions + +- Plain text editor with capitalization, autocorrect, and spellcheck + support. +- Show HTML output of the written org-mode. +- Download the org-mode content to a local file. +- Download the parsed HTML output to a local file. + +## Further Development + +### <span class="done DONE">DONE</span> Explore feasability of parsing org-mode to HTML constantly and sending parsed HTML output to a "viewing" pane. + +## Screenshots + +<figure> +<img src="./screenshots/light_preview.png" /> +<figcaption>Light Mode</figcaption> +</figure> + +<figure> +<img src="./screenshots/dark_preview.png" /> +<figcaption>Dark Mode</figcaption> +</figure> diff --git a/README.org b/README.org deleted file mode 100644 index 7612b7e..0000000 --- a/README.org +++ /dev/null @@ -1,22 +0,0 @@ -* README - -[[https://org.cmc.pub][org-live]] is a live environment for writing and -editing [[https://orgmode.org/][org-mode]]. - -** Functions - -- Plain text editor with capitalization, autocorrect, and spellcheck support. -- Show HTML output of the written org-mode. -- Download the org-mode content to a local file. -- Download the parsed HTML output to a local file. - -** Further Development -*** DONE Explore feasability of parsing org-mode to HTML constantly and sending parsed HTML output to a "viewing" pane. - -** Screenshots - -#+caption: Light Mode -[[./screenshots/light_preview.png]] - -#+caption: Dark Mode -[[./screenshots/dark_preview.png]] |