https://github.com/wader/jq-dash-docset
Tools to generate jq dash docset
https://github.com/wader/jq-dash-docset
dash documentation jq
Last synced: over 1 year ago
JSON representation
Tools to generate jq dash docset
- Host: GitHub
- URL: https://github.com/wader/jq-dash-docset
- Owner: wader
- Created: 2021-01-09T16:45:34.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-30T10:13:16.000Z (over 2 years ago)
- Last Synced: 2025-03-14T19:46:44.415Z (over 1 year ago)
- Topics: dash, documentation, jq
- Language: HTML
- Homepage:
- Size: 375 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# jq-dash-docset
[jq](https://jqlang.github.io/jq/) [dash](https://kapeli.com/dash) docset.
# Install docset in dash
Search for "jq" under "User Contributed Docsets" in dash.
Alternatively download or clone this repo and in dash under "Docsets"
preferences tab press "+", select "Add Local Docset" and browse to where
you downloaded and select the pre-built "jq.docset".
# Install docset in zeal
Go to https://zealusercontributions.now.sh/ and search for jq.
# Build docset yourself
```sh
docker build -t jqdocset - < Dockerfile && \
docker run --rm -v "$PWD:$PWD" -w "$PWD" jqdocset ./build_docset.sh
```
Now there should be a `jq.docset` directory that can be added as local docset and
a `contrib` directory with files suitable to submit as a user contributed docset.
# Thanks and license
Documentation and generated HTML is based on jq's own documentation system.
https://github.com/jqlang/jq/blob/master/COPYING