Skip to content
This repository has been archived by the owner on Jan 25, 2023. It is now read-only.

Latest commit

 

History

History
49 lines (30 loc) · 1.81 KB

README.md

File metadata and controls

49 lines (30 loc) · 1.81 KB

REDAXO Docset

Ein "Dash-Docset" für die Redaxo-API-Doku. Dash ist ein API-Browser für den Mac (und iOS).

Für Windows und Linux gibt es ähnliche Programme, die auch Docsets verarbeiten können (habe ich aber nicht getestet). Docsets gibt es für mehr als 200 APIs (JavaScript, PHP, HTML, VueJS, Python ... uswusf) und es gibt mehr als 100 Cheat-Sheets zu allen möglichen Themen (RegEx, Tmux, HTTP Statuscodes ... uswusf, auch sehr praktisch).


📣 Update

Das Docset ist nun Teil der User Contributed Docsets. Es sollte in Dash in den Preferences (Bereich Downloads) aktiviert werden, damit es automatisch aktualisiert wird.


English

A Dash docset for REDAXO Content Management System. About Dash (from the website):

Dash is an API Documentation Browser and Code Snippet Manager. Dash stores snippets of code and instantly searches offline documentation sets for 200+ APIs, 100+ cheat sheets and more. You can even generate your own docsets or request docsets to be included.

It's only available for Mac but there are ports for Windows and Linux as well (haven't tested, see below).

Docset generation

You'll need Python 3.7, Beautiful Soup and urllib3 installed on your machine. The most simple way is to install Pipenv, setup a new virtual environment with

pipenv install

and then just run

pipenv run python generate.py

That's it!

Links