Is a PDF or EPUB version of the Defold manual and API reference available for download? open web pages is so slowwing.
The docs are located on GitHub. You can download the repository and save it locally on your computer https://github.com/defold/doc
You can download the Defold API docset and use it via Dash (User Contributed Docsets) https://kapeli.com/dash
1 Like
thank you very much:grinning:
There is no pdf version of the docs I’m afraid. We could maybe generate it but it hasn’t been considered before.
There is the offline docs in the .docset file format as mentioned above. Dash has a Mac app and there is Zeal on Windows that can read the format as well.
I’m sure you can adapt the Python build script so that it spits out a .pdf instead.
Come again? Who is wasting time saving documents?
I just did. They are available through Dash and Zeal. And if you don’t like Dash/Zeal you are free to download raw data files yourself and generate in a format that you prefer (maybe using the script I provided). The API doesn’t change with every release so it’s really not something that needs to be done even on a bi-weekly basis. And as a rule of thumb we never ever remove an already existing API since we care a lot about backward compatibility.
Who is everyone? Don’t get me wrong, I’m not against the idea of also providing a PDF, it’s just that no one has asked for it before. We don’t spend time guessing what people may want (we don’t have the luxury of wasting time like that).
1 Like
Any news here? This would be very useful to me because I’m offline most of the time.
Even if I’ve downloaded the docs repo from Github I find myself wasting time navigating the files searching for the one I’m looking for.
A PDF version or simply a script to serve documentation on a local server would be very helpful!
1 Like
If you are on Windows use https://zealdocs.org/ with the feed url http://zealusercontributions.herokuapp.com/docsets/Defold.xml
1 Like
Is there any chance for manuals to get added to zeal docs? I usually visit them first alongside of public example.
1 Like
Dash is not free so I was using MkDocs for offline API browsing. It has search option too.
It is a quite easy solution:
- Install MkDocs
- Get doc files by using @britzl 's Python build script
- Start local server.
Here is my setup with Material for MkDocs:
4 Likes
I’m looking for the manuals
Btw, I’ve already downloaded the Dash socket, was looking into it and all sounds pretty straightforward to learn.
Download
https://github.com/defold/doc/archive/master.zip
Then you can use any markdown reader (or plain text editor) to read the docs.
Yes, I already have everything you mentioned, but I found it very cumbersome. I’d prefer to serve manuals on a local server so I don’t have to browse through files. Something like serving files through MkDocs or Hugo.
Why don’t you set that up and write out the steps on how you did it? Or make a project on Github with the exact setup you are wanting?
The raw data is there, you can transform it however you want.
Then, maybe you just want to try this, the way we verify the site before publishing:
2 Likes
You can do this. Just download the docs repo .
> mkdocs new folder-name
Copy “docs” folder content from downloaded zip to “folder-name/docs” and start the server
> mkdocs serve
It is not organized like the actual website but you can use search. Also you can build index page/navigation by parsing docs/en/en.json
4 Likes
I’m afraid that repo is private.
That was exactly what I was looking for. Thanks!
1 Like