20

Github GitHub - blahgeek/emacs-devdocs-browser

 3 years ago
source link: https://github.com/blahgeek/emacs-devdocs-browser
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
neoserver,ios ssh client

Emacs Devdocs Browser

Browse devdocs.io documents inside Emacs!

Features

  • Browse API documentations provided by devdocs.io inside Emacs using EWW, with:
    • Specifically improved formatting, including highlighted code blocks
    • Extra commands like "jump to other sections", "open in default browser"
  • Manage (install, upgrade, uninstall, etc.) docsets
  • Optionally download full content for offline usage

Quick Start

  1. Install package from MELPA. This package does not depend on other libraries and should work with emacs >= 27.1.
  2. Invoke M-x devdocs-browser-install-doc to install some docs.
  3. Invoke M-x devdocs-browser-open or M-x devdocs-browser-open-in to browse some entry.
  • Why browsing the doc inside Emacs instead of opening the page in the web browser?

Less navigation, consistent theme/color, consistent keybindings.

  • Why using EWW instead of XWidget, emacs-webkit or EAF?

    1. EWW is a builtin package and written in elisp: works across platforms, well supported, customizable.
    2. EWW is text-based: consistent theme/color, consistent keybindings, copiable and searchable, faster and use less resources.

  • Why Devdocs.io instead of Dash docs?

Devdocs.io provides all API documentations converted to plain HTML content without custom styling, scripting, headers or footers, which makes it very suitable for EWW.

References

All public functions and variables are documented in the code. Here list some common used ones.

Docsets Management

Useful functions:

  • devdocs-browser-list-docs
  • devdocs-browser-update-docs
  • devdocs-browser-install-doc
  • devdocs-browser-uninstall-doc
  • devdocs-browser-upgrade-doc
  • devdocs-browser-download-offline-data
  • devdocs-browser-remove-offline-data

Each docset have a SLUG and a NAME. SLUG is the unique id (e.g. python~3.8) and NAME is a human-readable string (e.g. Python). Pay attention to the type of the arguments (usually slug or slug-or-name) of each functions.

Open Docset Entry

Useful functions:

  • devdocs-browser-open
  • devdocs-browser-open-in

devdocs-browser-open-in accept a list of devdocs as parameter (or read from minibuf when called interactively), while devdocs-browser-open will use the current active docsets by default.

The current active docsets are determined by current major mode (see devdocs-browser-major-mode-docs-alist), or by a buffer-local variable devdocs-browser-active-docs.

Commands in devdocs buffer

  • devdocs-browser-eww-goto-target (C-c C-r): jump to targets in current buffer
  • devdocs-browser-eww-open-in-default-browser (C-c C-o): open current page in devdocs.io using default browser

report

Recommend

  • 112
    • Github github.com 7 years ago
    • Cache

    GitHub - Thibaut/devdocs: API Documentation Browser

    DevDocs — API Documentation Browser DevDocs combines multiple developer documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, key...

  • 90
    • Github github.com 7 years ago
    • Cache

    GitHub - rhysd/devdocs.vim: Open devdocs.io from Vim

    devdocs.vim This is a Vim plugin for devdocs, which is an awesome multiple API documentation service. You can open and search devdocs from Vim. Open and search devdocs using...

  • 63
    • Github github.com 7 years ago
    • Cache

    GitHub - qwfy/doc-browser: A documentation browser with support for DevDocs and...

    GitHub is where people build software. More than 27 million people use GitHub to discover, fork, and contribute to over 80 million projects.

  • 44
    • devdocs.io 6 years ago
    • Cache

    DevDocs API Documentation

    Fast, offline, and free documentation browser for developers. Search 100+ docs in one web app: HTML, CSS, JavaScript, PHP, Ruby, Python, Go, C, C++…

  • 17
    • Github github.com 3 years ago
    • Cache

    GitHub - astoff/devdocs.el: Emacs viewer for DevDocs

    devdocs.el — Emacs viewer for DevDocs devdocs.el is a documentation viewer similar to the built-in Info browser, but geared towards documentation obtained from the DevDocs website. The stable versio...

  • 5
    • devdocs.io 3 years ago
    • Cache

    DevDocs — Composer documentation

    DevDocs — Composer documentation You're browsing the Composer documentation. To browse all docs, go to devdocs.io (or press esc).

  • 8
    • devdocs.io 3 years ago
    • Cache

    DevDocs — Kotlin documentation

    DevDocs — Kotlin documentation You're browsing the Kotlin documentation. To browse all docs, go to devdocs.io (or press esc).

  • 10
    • devdocs.io 3 years ago
    • Cache

    nginx documentation — DevDocs

    nginx documentation — DevDocs Tracking cookies We would like to gather usage data about how DevDocs is used through Google Analytics and Gauges. We only collect anonymous traffic information. Please confirm if you accept our tracki...

  • 13
    • devdocs.io 3 years ago
    • Cache

    DevDocs — LÖVE documentation

    DevDocs — LÖVE documentation You're browsing the LÖVE documentation. To browse all docs, go to devdocs.io (or press esc).

  • 4
    • devdocs.io 3 years ago
    • Cache

    devdocs.io

    This site can’t be reached The webpage at https://devdocs.io/react/ might be temporarily down or it may have moved permanently to a new web address. ...

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK