Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add module docs #55

Merged
merged 3 commits into from
Aug 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
## @cosense/types

[![JSR](https://jsr.io/badges/@cosense/types)](https://jsr.io/@cosense/types)
[![test](https://github.com/scrapbox-jp/types/workflows/ci/badge.svg)](https://github.com/scrapbox-jp/types/actions?query=workflow%3Aci)

Type definitions for [cosense](https://cosen.se)

## Getting Started
Expand Down
3 changes: 0 additions & 3 deletions mod.ts

This file was deleted.

5 changes: 4 additions & 1 deletion rest.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
/** @module types used at REST API */
/** type definitions for Cosense REST API responses
*
* @module
*/

export * from "./base.ts";
export * from "./commit.ts";
Expand Down
6 changes: 4 additions & 2 deletions userscript.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
/** @module types used at UserScript */

/** type definitions for Cosense UserScript
*
* @module
*/
export * from "./base.ts";
export * from "./blocks.ts";
export * from "./node/node.ts";
Expand Down