Versions

Description

Dokang is a lightweight documentation repository. It is a web application that: 1. Provides an endpoint for clients to upload their documentation. Sending documentation to Dokang is as simple as issuing a POST query such as: .. code:: bash $ curl \ -X POST \ --form name=project_name \ -F ":action=doc_upload" \ -F content=@../documentation.zip \ http://dokang:my-secret-token@dokang.example.com/upload 2. Serves a home page with a list of all documentations and a simple search form that lets users search in HTML, text and PDF files. Other formats can be handled through the use of extensions. 3. Serves all documentations. Dokang also comes with a command line interface. It is lightweight in the sense that it is merely a wrapper around the Whoosh search engine with a very simple HTML text indexer. It can be extended to retrieve content from other types of files (such as PDF). Dokang is similar to Readthedocs (although Readthedocs has a much broader set of features) but provides a global search across all hosted documentations. All of this is provided with a simple setup that does not need any relational database. We (`Polyconseil`_) use it to search through the `Sphinx <http://sphinx-doc.org/>`_-generated documentation of all our projects. However, it may be used to host any kind of documentation. .. _Polyconseil: https://www.polyconseil.fr/

Repository

http://github.com/Polyconseil/dokang.git

Project Slug

dokang

Last Built

1 year, 11 months ago passed

Maintainers

Home Page

https://dokang.readthedocs.io

Badge

Tags

documentation, search

Short URLs

dokang.readthedocs.io
dokang.rtfd.io

Default Version

latest

'latest' Version

master