Sorry, we don't support your browser.  Install a modern browser

Dash and DevDocs docsets for Kirby#168

An offline version of the Kirby reference for Dash.

3 years ago
3
?

Dash is nice, but even better would be a docset in DevDocs:
https://devdocs.io

3 years ago
1

Well, it depends on what tool you are using. If you use Dash (like I do), a DevDocs docset won‘t help.

Unfortunately the two systems are not compatible, so they need to be implemented separately. Therefore please create a new idea about DevDocs so we can see which tool is used most by our users.

3 years ago

Ideally, it would be great to see support for BOTH. Dash has a great interface, integrates directly with the system, has support for a very large number of languages, and offer functions that go beyond mere language documentation - e.g., it can also be a snippet holder. But it is Mac-only, and goes well with Mac-only tools like Nova. DevDocs is multi-platform, and integrates directly with several multi-platform editors - like VS Code and Sublime Text.

I believe both have well-documented processes for producing doc files that they accept, and I know that a lot of Kirby’s docs are produced ‘automagically’ from the comments in the code itself, so perhaps there might be a way to auto-generate the needed docs for both systems… Not sure how much effort+time would be needed, though…

3 years ago
Changed the title from "Dash docset for Kirby" to "Dash and DevDocs docsets for Kirby"
3 years ago

I agree! If this gets enough upvotes, we will take a look at both.

3 years ago
7
?

I use Dash, but my freelancers use DevDocs - both would be great.

3 years ago
?

+1 for DevDocs support

3 years ago

via Discord: maybe the Dash Docset Builder (PHP) could be of use for automating this? https://github.com/godbout/dash-docset-builder

3 years ago
?

+1 for Dash 🙏

3 years ago
?

+1 for Dash. It has extra benefit that more Mac programmers will find out about Kirby.

3 years ago
?

+1 for DevDocs, please.

3 years ago

@Lukas Bestle, do you still use Dash yourself? It would be great to figure out how we can generate docsets for whatever software people are using. I built a plugin with a json route to generate VSCode snippets — something similar could be done in the getkirby.com repository.

a year ago

I still use Dash.

What if we offer content representations for all docs pages on getkirby.com? Maybe .snippet for a reduced page layout without navigation etc. Then we could also offer .json representations for the guide, reference and cookbook main pages that each contain the necessary information for the table of contents.

a year ago
1