org-share-to-web.el/README.md

44 lines
1.0 KiB
Markdown
Raw Normal View History

2023-06-13 10:20:08 +02:00
## Install
Add in your `init.el`.
```elisp
(use-package org-share-to-web
:straight (:host github :repo "tanrax/org-share-to-web.el" :files ("org-share-to-web.el"))
:ensure t)
```
2023-06-13 10:11:28 +02:00
## Configure
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 "")
```
Example.
```elisp
(setq org-share-to-web-domain "https://mydomain.com/")
(setq org-share-to-web-directory "/ssh:debian@mydomain.com:~/www/")
```
2023-06-13 10:24:53 +02:00
## Run
Open an Org file and run `org-share-to-web-buffer`.
It will copy the URL to your clipboard to open the document share.
2023-06-13 12:33:00 +02:00
2023-06-14 12:33:35 +02:00
If you need to manage the shared files, such as deleting them, use `org-share-to-web-dired`.
2023-06-13 12:33:00 +02:00
## Theme
If you want it to look really nice, include the following lines at the beginning of your Org documents.
```org
2023-06-13 12:55:47 +02:00
#+html_head: <link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/tanrax/org-share-to-web.el/themes/light.css">
2023-06-13 12:33:00 +02:00
#+OPTIONS: toc:nil
#+OPTIONS: html-postamble:nil
```