https://github.com/syrupthinker/docuraptor

Docuraptor is a JS/TS documentation generator and server.
https://github.com/syrupthinker/docuraptor

deno documentation documentation-generator javascript typescript

Last synced: 9 months ago
JSON representation

Docuraptor is a JS/TS documentation generator and server.

• Host: GitHub
• URL: https://github.com/syrupthinker/docuraptor
• Owner: SyrupThinker
• License: isc
• Archived: true
• Created: 2020-07-20T12:44:34.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-03-26T18:41:11.000Z (about 4 years ago)
• Last Synced: 2025-05-24T00:14:34.240Z (about 1 year ago)
• Topics: deno, documentation, documentation-generator, javascript, typescript
• Language: TypeScript
• Homepage:
• Size: 628 KB
• Stars: 15
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Docuraptor



Docuraptor is an offline alternative to the [doc.deno.land](https://doc.deno.land) service.

It generates and serves HTML documentation for JS/TS modules with the help of [Deno's](https://deno.land) documentation parser.

## Features

- Offline documentation

- Usable without browser JavaScript, for example in `w3m`

- Dark and Light theme

## Installation

`$ deno install -A https://deno.land/x/docuraptor@20200930.0/docuraptor.ts`

The permissions can be restricted.

Read the `--help` documentation for more details.

## Usage

`$ deno run https://deno.land/x/docuraptor@20200930.0/docuraptor.ts --help`

## Examples

![Docuraptor in w3m screencast](./assets/demo.svg)

_Docuraptor with `BROWSER=w3m`_

![Docuraptor documentation screenshot](./assets/screenshot.png)