API

dedoc – terminal-based viewer for DevDoc

dedoc is a terminal-based viewer for DevDocs. It lets you search and view developer documentation offline without needing a web browser or desktop environment.

Pages are translated from HTML to coloured text for terminal viewing. dedoc can download docsets, search documentation, open specific pages or fragments, and pipe its output to pagers and other command-line tools.

This is free and open source software.

Key Features

  • Search and view DevDocs documentation offline from the terminal.
  • Download and manage documentation sets.
  • Translate HTML pages to coloured terminal text.
  • Search for pages, fragments, and text within documentation.
  • Perform case-insensitive and whole-sentence searches.
  • Open specific pages or documentation fragments.
  • Pipe output to pagers and other command-line tools.
  • Render entire docsets to plain text.
  • Offer porcelain output for easier scripting.
  • Support a configurable application directory with the DEDOC_HOME environment variable.

Website: github.com/toiletbril/dedoc
Support:
Developer: toiletbril
License: GNU General Public License v3.0

dedoc usage, subcommands and options

dedoc is written in Rust. Learn Rust with our recommended free books and free tutorials.


Related Software

API Documentation Browsers
DevDocsAPI documentation browser written in Ruby and JavaScript
ZealSimple offline documentation browser
Qt AssistantTool for viewing on-line documentation in Qt help file format
BibliotecaBrowse and read GNOME documentation
DevhelpDeveloper tool for browsing and searching API documentation
dedocTerminal-based viewer for DevDoc
dashtSearch API docs offline in your terminal or browser
FerritinTerminal-based Rust documentation viewer
quickDocsDeveloper docs reader
Doc BrowserAPI documentation browser with support for DevDocs, Dash and Hoogle

Read our verdict in the software roundup.


Best Free and Open Source Software LinuxLinks helps you discover the best free and open source software for Linux. Explore our extensive collection of recommended applications, including alternatives to popular proprietary software.

We also publish software reviews, Linux tutorials, hardware reviews, free programming books and articles covering the wider open source community. Browse our Linux resources to discover more.

Know a useful free and open source Linux application we haven't covered? Suggest a program for inclusion.

Has your software been featured on LinuxLinks? Display one of our Featured on LinuxLinks badges on your website or GitHub README.
Subscribe

Please read our Comment Policy before commenting.

Notify of
guest
0 Comments
Oldest
Newest Most Voted