[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/webpaste cf2ea41 218/298: Update heading levels and add a
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/webpaste cf2ea41 218/298: Update heading levels and add a TOC |
Date: |
Thu, 9 Dec 2021 19:00:17 -0500 (EST) |
branch: elpa/webpaste
commit cf2ea4148692cb041cafd30121c09ae51791b0b5
Author: Elis Hirwing <elis.axelsson@gmail.com>
Commit: Elis Hirwing <elis.axelsson@gmail.com>
Update heading levels and add a TOC
---
README.org | 41 ++++++++++++++++++++++++++++-------------
1 file changed, 28 insertions(+), 13 deletions(-)
diff --git a/README.org b/README.org
index 56dfe7d..204994e 100644
--- a/README.org
+++ b/README.org
@@ -1,17 +1,32 @@
-* Webpaste.el -- Paste text to pastebin-like services
[[https://www.gnu.org/licenses/gpl-3.0.txt][https://img.shields.io/badge/license-GPL_3-green.svg]]
[[https://melpa.org/#/webpaste][https://melpa.org/packages/webpaste-badge.svg]]
[[https://stable.melpa.org/#/webpaste][https://stable.melpa.org/packages/webpaste-badge.svg]]
[[https://travis-ci.org/etu/webpaste.el][https://travis-ci.org/etu/webpaste.el.svg?branch=master]]
[[https://coveralls.io/github/etu/webpaste.el?branch=master][https://coveralls.io/repos/github/etu/webpaste.el/badge.svg?branch=master]]
+* Webpaste.el -- Paste text to pastebin-like services
This mode allows to paste whole buffers or parts of buffers to
pastebin-like services. It supports more than one service and will
failover if one service fails. More services can easily be added
over time and prefered services can easily be configured.
-** Installation
-*** The lazy way (Using
[[https://github.com/jwiegley/use-package][use-package]])
+* Table of Contents :TOC_3_gh:
+ - [[#webpasteel----paste-text-to-pastebin-like-services][Webpaste.el -- Paste
text to pastebin-like services]]
+ - [[#installation][Installation]]
+ - [[#the-lazy-way-using-use-package][The lazy way (Using use-package)]]
+ - [[#configuration][Configuration]]
+ - [[#choosing-providers--provider-priority][Choosing providers / provider
priority]]
+ - [[#confirm-pasting-with-a-yesno-confirmation-before-pasting][Confirm
pasting with a yes/no confirmation before pasting]]
+ - [[#view-recently-created-pastes][View recently created pastes]]
+ - [[#send-the-returned-url-to-the-killring][Send the returned URL to the
killring]]
+ - [[#copy-url-to-the-clipboard][Copy URL to the clipboard]]
+ - [[#open-the-recently-created-paste-in-the-browser][Open the recently
created paste in the browser]]
+ - [[#use-a-custom-hook][Use a custom hook]]
+ - [[#custom-providers][Custom providers]]
+ - [[#providers-to-implement-710][Providers to implement]]
+
+* Installation
+** The lazy way (Using
[[https://github.com/jwiegley/use-package][use-package]])
This requires that you have
[[https://github.com/jwiegley/use-package][use-package]] set up. But it's in my
opinion the
easiest way to install and configure packages.
@@ -22,8 +37,8 @@ easiest way to install and configure packages.
("C-c C-p C-r" . webpaste-paste-region)))
#+END_SRC
-** Configuration
-*** Choosing providers / provider priority
+* Configuration
+** Choosing providers / provider priority
To select which providers to use in which order you need to set the variable
=webpaste-provider-priority= which is a list of strings containing the
providers names.
@@ -54,7 +69,7 @@ This can be added to the =:config= section of use-package:
(setq webpaste-provider-priority '("ptpb.pw" "dpaste.de"))))
#+END_SRC
-*** Confirm pasting with a yes/no confirmation before pasting
+** Confirm pasting with a yes/no confirmation before pasting
To enable a confirmation dialog to always pop up and require you to confirm
pasting before text is actually sent to a paste-provider you just need to set
the variable =webpaste-paste-confirmation= to a value that is non-nil.
@@ -68,10 +83,10 @@ Example:
Can also be put in the =:config= section of =use-package= the same way as the
provider definitions above.
-*** View recently created pastes
+** View recently created pastes
Webpaste gives you several options to view your succesful paste.
-**** Send the returned URL to the killring
+*** Send the returned URL to the killring
This is webpaste's default behavior. After a succesfull paste, the returned URL
from the provider will be sent to the killring. You can disable this with
@@ -79,7 +94,7 @@ from the provider will be sent to the killring. You can
disable this with
(setq webpaste-add-to-killring nil)
#+END_SRC
-**** Copy URL to the clipboard
+*** Copy URL to the clipboard
If you have [[https://github.com/rolandwalker/simpleclip][simpleclip]]
installed, you can copy the returned URL to the
clipboard. You can enable this with
@@ -87,7 +102,7 @@ clipboard. You can enable this with
(setq webpaste-copy-to-clipboard t)
#+END_SRC
-**** Open the recently created paste in the browser
+*** Open the recently created paste in the browser
To enable opening of recently created pastes in an external browser, you can
enable the option =webpaste-open-in-browser= by setting this value to a
non-nil value.
@@ -101,7 +116,7 @@ Example:
Can also be put in the =:config= section of =use-package= the same way as the
provider definitions above.
-**** Use a custom hook
+*** Use a custom hook
You can define a custom hook to send your URL's to when returning them from
the paste provider. This is just like regular hooks for major modes etc. You
can have several hooks as well if you want it to do several custom things.
@@ -117,7 +132,7 @@ can have several hooks as well if you want it to do several
custom things.
(lambda (url) (browse-url-generic url)))
#+end_src
-*** Custom providers
+** Custom providers
The example of one of the simplest providers possible to write:
#+begin_src emacs-lisp
(require 'webpaste)
@@ -137,7 +152,7 @@ webpaste first and then just read the documentation by
running this:
(describe-function 'webpaste--provider)
#+end_src
-** TODO Providers to implement [7/10]
+* TODO Providers to implement [7/10]
- [X] ptpb.pw
- [X] ix.io
- [X] dpaste.com
- [nongnu] elpa/webpaste 533bb40 290/298: Apply suggestions from code review, (continued)
- [nongnu] elpa/webpaste 533bb40 290/298: Apply suggestions from code review, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste dacb4fb 289/298: Add support for bpa.st pastebin, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 9ffa782 286/298: readme: Useful links in badges, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste a60d262 285/298: readme: Add status badges, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 65f664d 298/298: elpaignore: Add .elpaignore to ignore files in elpa builds, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 76d740e 283/298: travis: Drop travis, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 935eb5f 195/298: Remove :tangle yes from README, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 5c63d75 196/298: Added unit test for running hooks on return, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 6114da7 208/298: Refactor how integration tests are triggered, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 9d026d6 212/298: Remove emacs-24.3 from build target, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste cf2ea41 218/298: Update heading levels and add a TOC,
ELPA Syncer <=
- [nongnu] elpa/webpaste 7c3bc88 215/298: Remove unused local variable, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 9972cf4 224/298: Fix some checkdock warnings, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste b1cdedb 213/298: Simplify travis file, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste bd38635 253/298: [readme] Add two new suggestions for providers, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 01c2858 261/298: Fix typos, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste e7fed98 246/298: Reindent entire webpaste.el to match updated indentation style, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 9d3c866 233/298: WP-25: Implement support for raw pastes, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste ef33b0f 269/298: Fix provider definition issue and add test for paste.mozilla.org, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste b713d5e 259/298: travis: Drop tests for versions where cask seems to be incompatible, ELPA Syncer, 2021/12/09
- [nongnu] elpa/webpaste 2decf1e 276/298: Revert "Fix bug in webpaste-paste-buffer-or-region when you don't have a region", ELPA Syncer, 2021/12/09