andros/org-share-to-web.el
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add demo

Browse Source
This commit is contained in:
Andros Fenollosa 2023-06-19 16:02:33 +02:00
parent a70f476658
commit e599e3d6b1
2 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -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. 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 ## Requirements
- Domain. - **Domain**: To access the file share.
- Hosting. - **Hosting**: To host the file share. It is recommended to use a server with SSH access.
- TRAMP. - **TRAMP**: To access the hosting.
## Install ## Install
@ -18,13 +20,12 @@ Add in your `init.el`.
## Configure ## 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 ```elisp
(setq org-share-to-web-domain "") (setq org-share-to-web-domain "") ; Domain
(setq org-share-to-web-directory "") (setq org-share-to-web-directory "") ; TRAMP path
``` ```
Example. Example.
```elisp ```elisp
@ -32,6 +33,8 @@ Example.
(setq org-share-to-web-directory "/ssh:debian@mydomain.com:~/www/") (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 ## Run
Open an Org file and run `org-share-to-web-buffer`. Open an Org file and run `org-share-to-web-buffer`.

BIN
demo.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 754 KiB