https://github.com/deuill/xmpp-xep-dash-docset

Dash Docset generator for XMPP XEPs. Just add water.
https://github.com/deuill/xmpp-xep-dash-docset

dash dash-docset

Last synced: 1 day ago
JSON representation

Dash Docset generator for XMPP XEPs. Just add water.

• Host: GitHub
• URL: https://github.com/deuill/xmpp-xep-dash-docset
• Owner: deuill
• License: mit
• Created: 2022-05-23T21:37:24.000Z (over 2 years ago)
• Default Branch: trunk
• Last Pushed: 2024-01-30T15:48:14.000Z (11 months ago)
• Last Synced: 2024-12-19T11:09:29.446Z (9 days ago)
• Topics: dash, dash-docset
• Language: Makefile
• Homepage:
• Size: 47.9 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Dash Docset for XMPP XEPs

This repository will automatically clone and generate a valid Dash Docset for XMPP XEPs.

### Update

The source XEPs to be included in the resulting docset are pulled automatically from the respective

[repository](https://github.com/xsf/xeps). Pulling and keeping this up-to-date is important in being

able to build a useful doc-set, and you can do this like so:

```sh

git submodule update --remote --recursive

```

Building the docset might fail if the above was not done and this repository wasn't cloned via `git

clone --recursive`.

## Build

Building a new Docset requires a single command and a few dependencies:

  - `envsubst` for creating an info file from the templated source.

  - `sqlite3` for adding entries for XEPs in the embedded Dash database.

  - `xmllint` and `xsltproc` for actually building the HTML files for the XML source.

  - `tar` and `gzip` for building the final package.

With these dependencies in place, you can just run `make` in the root directory of the repository.

## Install

You can install the resulting docset by either using the `build/XEPs.tgz` package directly, or,

alternatively, by using the feed hosted here, the URL for which is:

```

https://raw.githubusercontent.com/deuill/xmpp-xep-dash-docset/trunk/XEPs.xml

```

Copying this into your application of choice (Dash, Zeal, etc.) should automatically pull in any

future updates to the docset.

## License

All code in this repository is covered by the terms of the MIT License, the full text of which can

be found in the LICENSE file.

All other code, images, etc. are property of their respective owners.