Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/felixschl/ctrlp-unity3d-docs

Search the unity3d docs using ctrlp.vim.
https://github.com/felixschl/ctrlp-unity3d-docs

Last synced: 7 days ago
JSON representation

Search the unity3d docs using ctrlp.vim.

Awesome Lists containing this project

README

        

ctrlp-unity3d-docs
==================
Search the unity3d docs using ctrlp.vim.

Usage
-----

* Use `:CtrlPUnity3DDocs` to launch the search.
* Hit `` to view the selected item in browser

Requirements
------------

* [CtrlP](https://github.com/kien/ctrlp.vim) for the seach mechanism
* [open-browser](https://github.com/tyru/open-browser.vim) for launching the browser

Todo
----

* Perform check if required plugins are available
* Integrate python tool with Vim (to re-download the index for a new version of Unity).

Rebuilding index
----------------

Use the `tools/unity3d-docs-download.py` python script to re-download the index.
It's written against Python 2.7 in order to integrate it into vim at some point.

Caveats
-------

In order not to rely on third party libraries, the information is pulled from
the Unity docs website using *HTMLParser*. If the structure of the site was
to change, the tool will need to be adapted.