branch: externals/devdocs commit e1b4b0258289d442e349f67f175f05be6f4347d4 Author: Augusto Stoffel <arstof...@gmail.com> Commit: Augusto Stoffel <arstof...@gmail.com>
Convert README to org format --- README.md | 48 ------------------------------------------------ README.org | 43 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 43 insertions(+), 48 deletions(-) diff --git a/README.md b/README.md deleted file mode 100644 index 1ca8b52..0000000 --- a/README.md +++ /dev/null @@ -1,48 +0,0 @@ -devdocs.el — Emacs viewer for DevDocs -===================================== - -<a href="http://elpa.gnu.org/packages/devdocs.html"><img alt="GNU ELPA" src="https://elpa.gnu.org/packages/devdocs.svg"/></a> -<a href="https://melpa.org/#/devdocs"><img alt="MELPA" src="https://melpa.org/packages/devdocs-badge.svg"/></a> - -devdocs.el is a documentation viewer similar to Emacs's built-in Info -browser, but geared towards documentation obtained from the [DevDocs] -website. The stable version is available from [GNU ELPA] and a -development version is available from [MELPA]; to install, type `M-x -package-install RET devdocs`. - - - -To get started, download some documentation with `M-x devdocs-install`. -This will first query https://devdocs.io for the available documents -and save the selected one to disk. Once you have the desired -documents at hand, call `M-x devdocs-lookup` to search for entries. - -In any given buffer, the first call to `devdocs-lookup` will query for -a list of documents to search (you can select more than one option by -entering a comma-separated list). This selection will be remembered -in subsequent calls to `devdocs-lookup`, unless a prefix argument is -given; in this case you can select a new list of documents. -Alternatively, you can set the `devdocs-current-docs` variable -directly, say via [dir-local variables] or a mode hook: - -```elisp -(add-hook 'python-mode-hook - (lambda () (setq-local devdocs-current-docs '("python~3.9")))) -``` - -In the `*devdocs*` buffer, navigation keys similar to Info and -`*Help*` buffers are available; press `C-h m` for details. Internal -hyperlinks are opened in the same viewing buffer, and external links -are opened as `browse-url` normally would. - -Contributing ------------- - -Discussions, suggestions and code contributions are welcome! Since -this package is part of GNU ELPA, nontrivial contributions (above 15 -lines of code) require a copyright assignment to the FSF. - -[DevDocs]: https://devdocs.io -[GNU ELPA]: https://elpa.gnu.org/packages/devdocs.html -[MELPA]: https://melpa.org/#/devdocs -[dir-local variables]: https://www.gnu.org/software/emacs/manual/html_node/emacs/Directory-Variables.html diff --git a/README.org b/README.org new file mode 100644 index 0000000..c710806 --- /dev/null +++ b/README.org @@ -0,0 +1,43 @@ +#+title: devdocs.el --- Emacs viewer for DevDocs + +#+html: <a href="http://elpa.gnu.org/packages/devdocs.html"><img alt="GNU ELPA" src="https://elpa.gnu.org/packages/devdocs.svg"/></a> +#+html: <a href="https://melpa.org/#/devdocs"><img alt="MELPA" src="https://melpa.org/packages/devdocs-badge.svg"/></a> + +devdocs.el is a documentation viewer for Emacs similar to the built-in +Info browser, but geared towards documentation obtained from the +[[https://devdocs.io][DevDocs]] website. The stable version is available from [[https://elpa.gnu.org/packages/devdocs.html][GNU ELPA]] and a +development version is available from [[https://melpa.org/#/devdocs][MELPA]]; to install, type =M-x +package-install RET devdocs=. + +#+caption: image +[[https://user-images.githubusercontent.com/6500902/135726213-683b1f7d-5502-4afa-a549-c1aedaad8519.png]] + +To get started, download some documentation with =M-x +devdocs-install=. This will first query https://devdocs.io for the +available documents and save the selected one to disk. Once you have +the desired documents at hand, call =M-x devdocs-lookup= to search for +entries. + +In any given buffer, the first call to =devdocs-lookup= will query for +a list of documents to search (you can select more than one option by +entering a comma-separated list). This selection will be remembered +in subsequent calls to =devdocs-lookup=, unless a prefix argument is +given; in this case you can select a new list of documents. +Alternatively, you can set the =devdocs-current-docs= variable +directly, say via [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Directory-Variables.html][dir-local variables]] or a mode hook: + +#+begin_src elisp + (add-hook 'python-mode-hook + (lambda () (setq-local devdocs-current-docs '("python~3.9")))) +#+end_src + +In the =*devdocs*= buffer, navigation keys similar to Info and +=*Help*= buffers are available; press =C-h m= for details. Internal +hyperlinks are opened in the same viewing buffer, and external links +are opened as =browse-url= normally would. + +** Contributing + +Discussions, suggestions and code contributions are welcome! Since +this package is part of GNU ELPA, nontrivial contributions (above 15 +lines of code) require a copyright assignment to the FSF.