https://github.com/lolleko/unreal-docset

Dash docset generator for ue4
https://github.com/lolleko/unreal-docset

dash docs docset offline ue4 unreal unreal-engine unreal-engine-4 unreal-engine-5 zeal

Last synced: 4 months ago
JSON representation

Dash docset generator for ue4

• Host: GitHub
• URL: https://github.com/lolleko/unreal-docset
• Owner: lolleko
• Created: 2020-02-23T07:53:14.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-02-19T12:08:36.000Z (almost 4 years ago)
• Last Synced: 2024-05-01T15:22:42.071Z (9 months ago)
• Topics: dash, docs, docset, offline, ue4, unreal, unreal-engine, unreal-engine-4, unreal-engine-5, zeal
• Language: Go
• Homepage:
• Size: 6.59 MB
• Stars: 17
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Unreal docset generator for Dash

Docset generator for use with [Dash](https://kapeli.com/dash).

Should also work with [Zeal](https://zealdocs.org) and in a regular browser (just open the generated html files inside the docset directory).

### Requirements

* Go 1.13 (https://golang.org/dl/)

* UnrealEngine (http://www.unrealengine.com)

### Generating the docset

* Run `make`

* Run `./bin/unreal-docset`

The documentation will be scrapped from `docs.unrealengine.com`.

Scrapping requires around 7GB bandwidth and around 200k http requests.

Due to rate limitation the scrapping might take a while (up to an hour).

The resulting docset should be around 5GB in size.

### Known issues

* Page [types](https://kapeli.com/docsets#supportedentrytypes) are not always inferred correctly.