Hacker Newsnew | past | comments | ask | show | jobs | submit | Thibaut's commentslogin

The Elm docs unfortunately don't work without JavaScript enabled, which makes them difficult to scrape / add to DevDocs.


Elm package documentation is just JSON. Very easy to scrape.

Here's a list of all published Elm modules pointing to their respective packages: https://github.com/fiatjaf/module-linker/tree/backends/data/...

Scraped with this simple fish script: https://github.com/fiatjaf/module-linker/blob/backends/data/...


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). So the best way to "give back" is to spread the word, send a thank you note, and contribute (one thing in particular that would be great to see is more/better extensions & integrations with code editors).

(I'm the creator/maintainer of DevDocs)


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



I elaborated a little bit in the past here: https://groups.google.com/forum/#!topic/devdocs/T9_FsjB1kHw

I've been thinking about writing blog posts on DevDocs's internals and the techniques it uses for a while, but it's hard to find the time, especially when I already spend a lot of my spare time maintaining/updating the app.

That said, feel free to open a GitHub issue to remind me to write blog posts at some point (if there is interest), or if you have specific questions.


I was going to suggest -- a VS Code Extension would be cool.

edit: nvm. I found it: https://marketplace.visualstudio.com/items?itemName=akfish.v...


One of the greatest in-kind sponsorships MaxCDN did for sure. Really happy to see you're still at it after all these years Thibaut!


It happened thanks to you :) And you/MaxCDN also played a part in getting the app open-sourced sooner rather than later.

Happy our paths crossed again here!


Could you specify more on the front-end code on this project, did you hand-roll your own javascript front-end or did you use a framework? The whole thing is rather impressive and I'm looking to do something similar to your sidebar with my own project. Is all of your open source code open to be re-used/modified?


Thanks! The front-end doesn't use any JavaScript framework. See the code here: https://github.com/Thibaut/devdocs.

All of the code is licensed under MPL 2.0 [1], so you're welcome to reuse/modify it in your own projects.

[1]: https://github.com/Thibaut/devdocs/blob/master/LICENSE


Is there a way to request Elm library docs be included?


Nevermind. I just saw https://github.com/Thibaut/devdocs/blob/master/CONTRIBUTING....

You can submit pull requests to add new docs if you're so motivated.


And open-source :) (https://github.com/Thibaut/devdocs)

Disclaimer: I'm the maintainer of DevDocs


Well then let me thank and congratulate you for your efforts in building this.

As a long-time dash user in the past, devdocs felt like home and just works nicely and without any unnecessary features.


Is Elm support planned?


For `is * planned` refer to https://trello.com/b/6BmTulfx/devdocs-documentation. (Elm is in "To Do".)


http://devdocs.io/openjdk~8/ (Java SE is proprietary; OpenJDK is open-source)


Note: if you see "that page doesn't exist", wait a couple seconds and refresh (AppCache)


Oracle mention this on their website:

  This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means.
DevDocs is just a hobby of mine and I don't want to waste my time on a documentation that I may have to remove. If Oracle is willing to grant DevDocs a license (I haven't asked them) I'd gladly add the JDK docs to it.


Thanks! The project is open source: https://github.com/Thibaut/devdocs


Well done! I've also been trying to improve Ruby's documentation with DevDocs: http://devdocs.io/ruby/


Yes, sorry. I deployed a bug that blocked all browsers for a couple of minutes. It's fixed.


Added to my todo list. Thanks!


Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: