Being able to read documentation offline can be a huge boost to productivity because it allows to program without the giant distraction that is the web. I use Zeal for that purpose. One thing missing though is being able to lookup errors and problems. I would love to see a program that made possible to search an archive of SO and other various technical forums.
The idea is to expand beyond API docs and also include guides, examples and other stuff: see Reitit for a more complex scenario: https://cljdoc.xyz/d/metosin/reitit/0.1.1/doc/introduction/
Eventually, I would also like to package docsets for documentation browsers like Dash (https://kapeli.com/) & Zeal (https://zealdocs.org/).
CrossClj is a very cool project and I probably didn't look at it enough (yet) but there's a reason people publish Codox documentation and don't link to their respective CrossClj pages.
cljdoc's goal is to make it super easy for everyone publishing documentation for their Clojure/Script library (see rationale).
Since you seem to be the CrossClj author: is the code open source somewhere? Would be very curious to take a peek at your data model etc :)
I feel your pain...I find rustdoc docs to be a bit harder to explore than javadoc and more targeted at the lookup use case than the search use case. Though I will say that I think the book is pretty excellent for people who don’t yet know what they’re looking for.
But with all that said, there’s a few tools that I use that I find makes it a bit easier.
First, I use a program called Dash that allows for searching. It’s Mac only, but there’s a Windows/Linux equivalent called Zeal. Unfortunately it’s difficult to get rustdoc for individual crates to work with it, but it’s still useful for exploring the std crate.
Second, cargo doc --open
is good for pulling up a single browser window that can browse all rustdoc for all the crates used in your project. And since it stores the html in the project’s target directory, it works offline so it’s nice if you’re working on a plane or otherwise don’t have internet access.
And lastly, make sure you’ve got the IDE stuff setup for your editor. The just-in-time documentation you get from the language server can help to figure out which methods/functions are available on a given type.
Its an offline documentation manager/downloader/viewer Its Windows/Linux/BSD counter part is Zeal (Which uses the Dash docsets).
Basically you run it, say which languages you use and it downloads the documentation for those languages allowing you to search/browse those doc's without an internet connection or having to manually download the doc's an manage them yourself.
> But for documentation on Windows? I would pay a lot more than $10 to have a Windows port of Dash. VS docs are terrible, so is using Google.
There is Zeal which is available for Linux and Windows.
I assume you just want to learn the basics. I never really watched videos to learn how to code. I find reading and coding to be more helpful. For Python 2, I used Codecademy. I only know C++ not C, but this https://www.dipmat.univpm.it/~demeio/public/the_c_programming_language_2.pdf should be enough to get started with C. You can just google more pdfs for any language you want to learn if you don't like these. Also, download this https://zealdocs.org/, it helps a lot. If you have any more questions, feel free to ask me.
Use webmakerapp.com for all your small practices. It is better than codepen because it is offline (users service workers) and compiles in your browser (fast compile time).
For offline documentation, download Zeal. https://zealdocs.org/ Then download HTML, CSS, JavaScript docsets. This will save you a lot of time looking up docs online.
When you search for tutorial, ignore those published there years ago. They are outdated.
Then you can start replicating existing parts of websites. You should try one aspect of web development at a time, e.g. CSS grid.
You may learn Pug (HTML template language) and Stylus (transpile to CSS) for productivity.
For web applications, do not touch jQuery for your health. Use Vue (easy to learn), React (the popular one), Mithril (least amount of abstraction) or anything you want.
I used devdocs for a long time. Now I use zeal instead. Not too different, but I have a general preference for desktop UIs. If you only tried zeal when it first came out, it has gotten better.
I started with a python for data science course on Udemy, it requires some very beginner knowledge of python so if you've ever taken an intro to python course then you should be good to take this one, it does also have a "python crash course" section at the beginning. Also Udemy courses tend to go on sale a lot so check back often if you'd prefer to pay less:
https://www.udemy.com/course/python-for-data-science-and-machine-learning-bootcamp/
I also use Zeal to quickly look up a term from any of my downloaded dictionaries (numpy, pandas, matplotlib etc.). It's good for people who have slow/ no internet, as once it's downloaded, it can be used offline.
Once you've gotten a handle on a few of the concepts, I encourage you to create a Kaggle account, find a dataset related to your field, and practice doing some analysis on it! It's also a great way to start a portfolio and gain some constructive criticism.
It was mentioned as "Zeal/Dash" above because Zeal is an open source clone of Dash that runs on Linux and Windows. They use the same docsets, and Zeal doesn't have a macOS port to avoid conflict with the original Dash project (which does much of the work in making the docsets available).
As you advance, you'll need documentation. Zeal is perfect for that: install it, select languages you want and let them download. Then you can search through it without internet connection.
In addition to what has already been said: https://www.learncpp.com/
I know you said bad internet but you could download all the sites and then open them locally (obviously don't redistribute that or anything, copyright and stuff).
You should also provide him with https://en.cppreference.com/w/ to use as reference, it has offline archives ready to be downloaded or you use something like https://zealdocs.org/ (which also downloads from cppreference). Use the portable version, put it on a stick, download the C++ docs (and Python and whatever else you want), give him the stick. However note that while there are some examples, it is still a reference where you look up stuff and need a certain level of familiarity with the language to make sense of it.
But honestly it would probably be a good idea to provide him with some sort of regular internet access (even if it's just once a week/month) so he can ask questions here for example. Books are great and all but contact with more experienced persons and the ability to ask questions is invaluable for learning.
My inner impulsive side looks at anything that imports from a URL and recoils in disgust.
...but then I'm one of those people who uses things like Zeal, not just for the convenience, but because I'm ideologically against making "is my DSL up?" more of a single point of failure than it already is and I don't like stuff that gives the impression its authors assume the same level of Internet reliability as Silicon Valley companies.
(Plus, I consider it a big plus that Crates.io sits in between me and the URLs, ensuring that the upstream author can't break my build by deciding to change or delete the revision my Cargo.toml
is pinning.)
The short answer:
Not right now but I am considering it. Obviously I see the benefits and would love to use it if it were available but I don't think I'll personally have the time to work on it in the near future.
The long answer:
I actually started on this journey by creating a VSCode extension that provides an outline and a preview mode that activates when opening the XML protocol files (similar to how markdown outline and preview works in VSCode).
But the dev experience of iterating on the HTML of that extension proved too cumbersome. So instead I decided I'll iterate on the HTML using React and once it's done I'll just copy the resulting HTML back into preview of the VSCode extension.
However, once I had the React version working (e.g.: this website) I didn't go back to finish the VSCode extension. Partly because I didn't have the time and partly because I thought the user experience of that approach was worse than just using the website directly. That's because you would still need to have the XML files somewhere on your machine and juggling between files and then toggling Preview mode on and off didn't "feel" right.
Hence, it's only this website for now. But I think integrating it into some other app meant for reading documentation like Zeal is something that would make a lot of sense. But again, I don't think I'll personally have time to do that right now or in the near future.
This looks awesome! I have a love-hate relationship with https://kapeli.com/dash and its clones like https://zealdocs.org/ which similarly try to put documentation a few keystrokes away. Dash is great, has a lot of community-submitted documentation adapters, but it's not free, and code samples and StackOverflow always felt like an afterthought relative to official documentation. Your focus on developer ergonomics and keyboard control feels like a breath of fresh air, and I don't say that lightly - this is really, really well done.
You might benefit or draw inspiration from the Dash docset ecosystem at https://kapeli.com/docsets btw.
Looking forward to seeing this evolve!
you can also use the open source tool zeal to browse them offline entirely. I use it all the time to code on my laptop when I don't have internet, super handy and it has all kinds of docsets
It's totally possible to do Django development offline. Once you've installed all the packages you need, I'd also recommend getting an offline documentation viewer like Dash (https://kapeli.com/dash) or Zeal (https://zealdocs.org/) and downloading the docs for Python, Django, whatever database you'll be using, maybe django-rest-framework as well, etc, when you're connected to the internet. That way you'll have some references available when you're offline so you can troubleshoot without an internet connection.
J'ai commencé à apprendre Python, j'en suis à la base de la base
Pour l'instant je n'ai fait qu'une journée (enfin à moitié, j'apprenais entre 2 mails de vrai boulot) et j'en suis qu'aux fonctions trèèèèèèès basiques : input ; type ; pass et aux conditions.
Je sens que ça va être long.
Sinon j'ai appris grâce à un collègue, que la documentation des principaux langages de programmation peuvent être disponibles sur une seule plateforme sur Zeal et mises à jour automatiquement.
Autre sujet qui n'a rien à voir : je cherche un jeu android qui soit prenant et avec des mécanismes de "grinding" pour jouer un peu partout (transports, toilettes, boulot etc) et jouable en solo
I'm gonna take the opportunity to recommend Zeal. It's a programming docs browser that stores documentation for offline use. It has docs for both Qt 4 and 5, and C++ (which you are probably using) and many more.
> es que da demasiada ladilla empezar y ver todo de nuevo cuando ya "sabes algo"
Entonces no lo hagas. Mira esta lista de cursos basados en proyectos. Personalmente yo me aburro si el curso no me tiene desarrollando algo útil.
Cuando hayas hecho suficientes cosas de forma guiada, intenta programar algo tú sólo.Es normal sentir que no sabes lo suficiente para hacer algo, pero lo uses como una excusa para postergarlo.
Hoy en día, lo más probable es que tengas que aprender sobre la marcha y buscar ayuda en internet constantemente mientras haces un proyecto, lo que importa es que tengas una base.
Descargate ZealDocs para cuando no tengas internet, es una aplicación que te permite descargar la documentación de lenguajes y leerl offline.
Otra cosa que me ha ayudado bastante a leer y estudiar más es el método pomodoro.
> Es difícil agarrar concentración cuando uno vive encerrado en 4 paredes y sin amigos. :(
Así estamos muchos, con todos los amigos afuera. Se siente mal pero la vida sigue.
Mucha suerte!
I use Dash (https://kapeli.com/dash) or Zeal (https://zealdocs.org/) and have most of the things I'm using pre-downloaded. As for if I don't know how to code something, I learn how to code it by stepping through it. I come from an era before stackoverflow though, so a lot of the things I've learned to do happened without that as a crutch. Most of the algorithms in software engineering are ancient and so are contained in reference books, but in reality we tend to use very few of them.
I like to use Zeal (on Windows, but also available on other platforms), beside the internal help system.
I believe with small modifications it could be used with all the wonderful LipWorks manuals.
Thanks to /u/f0urier for another very fine LispWorks tool.
On what OS are you running? For me it is working perfectly, but I'm on Darwin (macOS). From what I see in the trace, open
. is missing, which. is used to open a GUI application on macOS. I assume that you're not using macOS. For other platforms, there is https://zealdocs.org. Maybe `dash-at-point` can be changed to support also zeal.
For Dash, there's Zeal, which uses Dash docsets.
Depending on what you use Karabiner for, Ubuntu's built-in GNOME Control Center keybinding settings may be good enough for you. If you need to remap keys to other keys, you might consider making a new layout.
I'm running on Linux and I'm using Zeal. It is available for Windows too. If you are on mac, you can use Dash. They use the same data as docset that is directly downloadable from the interface. You will find docset for many other subjects related to Python, like Django, Flask, Bottle, Matplotlib, Numpy, ...
- better and more modern integration with libpurple (pidgin) with all possible plugins (telegram, hangouts...)
- better UI for image viewer
- any fancy idea to keep your firefox bookmarks into org mode (org2firefox)
- volume control , bifghtness control, mouse speed control - so some basics configuration for system
- alternative for zealdocs : https://zealdocs.org/
The Hyperspec is available through Dash/Zeal. When you started looking for "values-list", I just popped zeal open (I have it assigned to a scratchpad which opens when I hit M4-z) and typed in "values" and saw what you were looking for much more quickly than it took to browse through the Hyperspec. I recommend trying it out. (Looks way nicer in "dark" mode too.)
> they also make some decisions in rust admitting that you will use google to help.
Even assuming that this comment was intended as a continuation of one of the other replies, I'm not sure how this argues against anything I said.
> they moved from ~T to Box<T> saying "it's more google-able", instead of allowing ~ to be overloaded for generality
Whether or not that's true, it's a decision that was made back when I was just starting to hear about Rust and I lack the context to have a strong opinion on it.
From what little I remember, it was because Box
, Rc
, and the Gc
they were anticipating adding at the time all originally had special sigils reserved, but they decided it didn't make sense to give those three cases special syntax when, design-wise, they weren't inherently different from what a third-party library might provide.
I'll admit that there are still a couple of spots where Box
gets special treatment by the compiler, but they do want to resolve those once they've handled more pressing stuff.
> so instead of your 'whole program searches' happening locally using some cached database infront of you , they're relying on global infrastructure to connect you to some centralised server
You can generate offline docs for the current project, plus all its dependencies, with built-in offline search, and open it in the browser, using cargo doc --open
.
Even if that weren't the case, I use the Zeal offline doc viewer to perform my searches on many different kinds of HTML-based documentation (including Rust stdlib, if I haven't used cargo doc
yet).
> keeping a browser window open beside your text editor... burning up more screen space
I keep a browser window open 24/7/365 anyway, so that's not really a powerful argument.
You might want some offline documentation. Consider using Zeal and downloading some docsets: https://zealdocs.org/
HTML, CSS, JavaScript, jQuery, PHP, MySQL, and WordPress might be worth getting as well as any others you think you'll find useful.
Came here to say this, my coworker introduced me to it and it's the shit. Link for the lazy. Also look into the original, Dash, if you're on OS X.
Devdocs need a browser but with the offline mode it's convenient. There also plugins for IDE (like atom) to open devdocs on function.
Another alternative is Zeal https://zealdocs.org/ (plugin for IDE integration also exist).
If you find something cool I would be interested, I actually use devdocs with atom integration and Zeal (as a backup solution if my browser cache is accidentally cleared).
Or if you prefer to have it on your HDD (even though devdocs provides the offline option): https://zealdocs.org/ or check out Zeal's latest releases.