/ddoc

📑 Offline deno documentation in a desktop app, generated locally

Primary LanguageTypeScriptMIT LicenseMIT


demo screenshot

ddoc

Offline / Local deno documentation

⚠️ This project is work in progress. Expect breaking changes.

installation

$ deno install -A -f --unstable https://deno.land/x/ddoc@0.0.2/ddoc.ts

usage

Local files

$ ddoc oak/mod.ts

Remote files

$ ddoc https://deno.land/x/oak/mod.ts

⚠️ Please note that remote files are cached locally after the first generation.

dev installation

Clone the repository and its only submodule (denosaurs/doc_website):

$ git clone --recurse-submodules https://github.com/denosaurs/ddoc

Statically build the denosaurs/doc_website using the build script:

$ deno run -A scripts/build.ts

And then you can run it:

$ deno run -A --unstable ddoc.ts

other

contributions

Pull request, issues and feedback are very welcome. Code style is formatted with deno fmt and commit messages are done following Conventional Commits spec.

license

Copyright 2020-present, the denosaurs team. All rights reserved. MIT license.