Hacker News Board Hacker News, browsed like a classic message board
Live data from Hacker News

DevDocs API Documentation

devdocs.io

Post reply on HN
Print view View original

41–50 of 145 posts

Re: DevDocs API Documentation

#41

Post by avtar »

sidthegeek wrote: post #35
Thibaut wrote: post #28

Earlier quoted context omitted.

Thanks! Your donation is very much appreciated. Don't feel like you have to donate, though. The app is cheap to host (one of the benefits of an offline-enabled, no-accounts-required, optimized-to-the-max web app is that the backend doesn't do much :P), and I'm lucky that MaxCDN & others are providing free service to the app. What keeps me going is seeing the impact that DevDocs is having (people using and liking it).…

Can you elaborate a bit about your implementation? I'd love to learn more about the techniques you have used.

https://github.com/Thibaut/devdocs

Re: DevDocs API Documentation

#42

Post by styfle »

For some reason, the theme/colors were a bit of a shock to my eyes. I can't explain why...maybe because it was my first time seeing it.

Compare these two pages:

https://devdocs.io/javascript/global_objects/array/entries

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe...

I think the blue "sections" on devdocs are really so they are not sections at all and it throws me off.

Re: DevDocs API Documentation

#43

Post by a_bored_husky »

majewsky wrote: post #19
marceldegraaf wrote: post #10

Reminds me of Dash[1] which is especially useful when configured in your editor: press a key to open documentation for the word under the cursor. 1: https://kapeli.com/dash

"Shift+K" does the same in vim. However, it looks for a manpage matching the word under the cursor, so it won't help you unless you're doing C or Perl.

`K` in vim uses the program defined in `keywordprg` which is `man` by default, but can be set to whatever you want according to the file type.

Re: DevDocs API Documentation

#44

Post by a_bored_husky »

no_wizard wrote: post #26
padiyar83 wrote: post #15

Earlier quoted context omitted.

But you pay for Dash subscription, this one seems to be free.

You pay for the software but it’s not a subscription. Just to clarify. For what it’s worth on Linux the open source alternative is Zeal https://zealdocs.org/

And dasht for the terminal

https://github.com/sunaku/dasht

Re: DevDocs API Documentation

#45

Post by baldfat »

Surprised that R isn't on there since it is a top 10 language. The ecosystem though is pretty huge and R Base without Hadley Wickham's tidyverse isn't very useful for me.

Also would love to see Racket notes.

Re: DevDocs API Documentation

#46

Post by user5994461 »

styfle wrote: post #42

For some reason, the theme/colors were a bit of a shock to my eyes. I can't explain why...maybe because it was my first time seeing it. Compare these two pages: https://devdocs.io/javascript/global_objects/array/entries https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe... I think the blue "sections" on devdocs are really so they are not sections at all and it throws me off.

Agreed. The thin and bright text is hard to read.

Re: DevDocs API Documentation

#48

Post by dccoolgai »

styfle wrote: post #42

For some reason, the theme/colors were a bit of a shock to my eyes. I can't explain why...maybe because it was my first time seeing it. Compare these two pages: https://devdocs.io/javascript/global_objects/array/entries https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe... I think the blue "sections" on devdocs are really so they are not sections at all and it throws me off.

Devdocs has an option for dark thene I use

Re: DevDocs API Documentation

#49

Post by epicide »

marceldegraaf wrote: post #10

Reminds me of Dash[1] which is especially useful when configured in your editor: press a key to open documentation for the word under the cursor. 1: https://kapeli.com/dash

This was my first thought, as well. I use Dash several times a day. It has been indispensable for me.

There are a few main things that will probably keep me on Dash, for the time being. In no particular order:

1. Global shortcut - Being able to quickly show-search-hide from anywhere is extremely useful for me. I can quickly refresh myself on the syntax of an uncommon function. The faster I can do that, the less likely I am to break my flow.

2. Support for random/obscure projects - On top of community-added docs, Dash lets you point it at any random GitHub project and it will pull down the README. This has come in handy plenty of times for me when using small tools and components. Sure, it's not as nice as full documentation, but it's nice having that README searchable in the same place and offline (see reason #1).

3. Docsets - Dash lets you define groups of frameworks (etc.) and name them. You can even specify which version of a framework to use in the docset. This allows me to tailor my results to a particular stack, depending on which project I'm currently working on.

EDIT: I should read :)

Re: DevDocs API Documentation

#50

Post by mattbeckman »

styfle wrote: post #42

For some reason, the theme/colors were a bit of a shock to my eyes. I can't explain why...maybe because it was my first time seeing it. Compare these two pages: https://devdocs.io/javascript/global_objects/array/entries https://developer.mozilla.org/en-US/docs/Web/JavaScript/Refe... I think the blue "sections" on devdocs are really so they are not sections at all and it throws me off.

Modify and submit a PR?
Post reply on HN