Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/denosaurs/ddoc

📑 Offline deno documentation in a desktop app, generated locally
https://github.com/denosaurs/ddoc

cli deno devtool documentation

Last synced: 4 months ago
JSON representation

📑 Offline deno documentation in a desktop app, generated locally

Host: GitHub
URL: https://github.com/denosaurs/ddoc
Owner: denosaurs
License: mit
Created: 2020-07-18T13:32:51.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2022-06-25T21:43:48.000Z (over 2 years ago)
Last Synced: 2024-04-14T00:49:17.944Z (10 months ago)
Topics: cli, deno, devtool, documentation
Language: TypeScript
Homepage: https://deno.land/x/ddoc
Size: 6.63 MB
Stars: 19
Watchers: 2
Forks: 1
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

demo screenshot

ddoc

Offline / Local deno documentation

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

## installation

```bash
$ deno install -A -f --unstable https://deno.land/x/[email protected]/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`](https://github.com/denosaurs/doc_website)):

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

Statically build the `denosaurs/doc_website` using the build script:

```bash
$ deno run -A scripts/build.ts
```

And then you can run it:

```bash
$ 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](https://www.conventionalcommits.org/en/v1.0.0/) spec.

### license