diff --git a/README.md b/README.md index 85b3248..63eb85c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ Share an Org buffer as a web page. In addition, a URL will be created that you can share to view it. +![Demo](demo.gif) + ## Requirements -- Domain. -- Hosting. -- TRAMP. +- **Domain**: To access the file share. +- **Hosting**: To host the file share. It is recommended to use a server with SSH access. +- **TRAMP**: To access the hosting. ## Install @@ -18,13 +20,12 @@ Add in your `init.el`. ## Configure -Configure the domain to be used to access the file share and the directory where it will be hosted using Tramp. +Configure the domain to be used to access the file share and the directory where it will be hosted using TRAMP. ```elisp -(setq org-share-to-web-domain "") -(setq org-share-to-web-directory "") +(setq org-share-to-web-domain "") ; Domain +(setq org-share-to-web-directory "") ; TRAMP path ``` - Example. ```elisp @@ -32,6 +33,8 @@ Example. (setq org-share-to-web-directory "/ssh:debian@mydomain.com:~/www/") ``` +The domain must end with `/`. The directory must end with `/` and start with `/ssh:` or another TRAMP method. + ## Run Open an Org file and run `org-share-to-web-buffer`. diff --git a/demo.gif b/demo.gif new file mode 100644 index 0000000..2b221a7 Binary files /dev/null and b/demo.gif differ