https://github.com/davidenke/mkdocs-ts

MkDocs to Typescript converter
https://github.com/davidenke/mkdocs-ts

Last synced: 29 days ago
JSON representation

MkDocs to Typescript converter

• Host: GitHub
• URL: https://github.com/davidenke/mkdocs-ts
• Owner: davidenke
• Created: 2022-11-26T23:19:00.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-01T07:07:47.000Z (about 2 years ago)
• Last Synced: 2023-03-27T11:08:07.161Z (over 1 year ago)
• Language: TypeScript
• Size: 2.33 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# MkDocs to Typescript Converter

This has been thrown together in a sleepless night 🌙.

After digging into the georgeous [Scriptable app](https://scriptable.app/) I wanted to improve the developer experience by providing types for the Scriptable API. So all efforts have been a bit biased to my needs to parse the [provided documentation](https://docs.scriptable.app/scriptable.json).

## Improvements

Some missing things that would be nice once another sleepless night comes around:

- some unit tests

- using e.g. ts-morph to build the AST

- running it against some other generated docs

- typings for the mkdocs json format (is there at least some schema out there?)

## Installation

```bash

npm i -D @davidenke/mkdocs-ts

```

or

```bash

npm install --save-dev @davidenke/mkdocs-ts

```

or

```bash

pnpm install --dev @davidenke/mkdocs-ts

```

or

```bash

yarn add --dev @davidenke/mkdocs-ts

```

## Usage

`mkdocs-ts  `

```bash

npm run mkdocs-ts ./example.json example.d.ts

```

or

```bash

npm run mkdocs-ts https://some.remote/example.json example.d.ts

```