dokio

Documentation generator for TypeScript projects.

npm i dokio -g

pnpm add dokio -g

yarn global add dokio

CLI

API

# api

src/api/index.ts#L1

# ExitCodes

src/api/produce.ts#L3

# CompileError

src/api/produce.ts#L7

3

# ExceptionThrown

src/api/produce.ts#L10

6

# NoEntryPoints

src/api/produce.ts#L6

2

# Ok

src/api/produce.ts#L4

0

# OptionError

src/api/produce.ts#L5

1

# OutputError

src/api/produce.ts#L9

5

# ValidationError

src/api/produce.ts#L8

4

# produce()

src/api/produce.ts#L13

produce()  =>

Promise<ProjectReflection | ExitCodes>

# render(doc, { expand })

src/api/render.tsx#L299

# doc

ProjectReflection

{
# expand

src/api/render.tsx#L299

boolean

}

render(doc, { expand })  =>

string

# bin

src/bin/index.ts#L1

# Bin

src/bin/produce.ts#L5

{

# name

src/bin/produce.ts#L6

string

# screenshot

src/bin/produce.ts#L7

string

# screenshotDimensions

src/bin/produce.ts#L8

{

# height

src/bin/produce.ts#L10

number

# width

src/bin/produce.ts#L9

number

}

}

# produce()

src/bin/produce.ts#L14

produce()  =>

Promise<Partial<Bin>>

# render(Bin)

src/bin/render.tsx#L5

Bin

render(Bin)  =>

string

# examples

src/examples/index.ts#L1

# ExampleFile

src/examples/produce.ts#L9

{

# contents

src/examples/produce.ts#L19

string

# fileName

src/examples/produce.ts#L11

string

# lang

src/examples/produce.ts#L12

string

# link

src/examples/produce.ts#L18

string

# name

src/examples/produce.ts#L10

string

# screenshot

src/examples/produce.ts#L13

string

# screenshotDimensions

src/examples/produce.ts#L14

{

# height

src/examples/produce.ts#L16

number

# width

src/examples/produce.ts#L15

number

}

}

# produce()

src/examples/produce.ts#L22

produce()  =>

Promise<ExampleFile []>

# render(examples)

src/examples/render.tsx#L79

# examples

ExampleFile []

render(examples)  =>

string

# footer

src/footer/index.ts#L1

# Footer

src/footer/produce.ts#L5

{

# deps

src/footer/produce.ts#L6

normalize.Package []

# pkg

src/footer/produce.ts#L7

normalize.Package & {

# short

src/footer/produce.ts#L7

string

}

}

# produce()

src/footer/produce.ts#L10

produce()  =>

Promise<{
# deps

src/footer/produce.ts#L23

any []

# pkg

src/footer/produce.ts#L23

any

}>

# render(Footer)

src/footer/render.tsx#L18

Footer

render(Footer)  =>

string

# header

src/header/index.ts#L1

# Header

src/header/produce.ts#L7

{

# brotli

src/header/produce.ts#L8

number

# loc

src/header/produce.ts#L10

any

# pkg

src/header/produce.ts#L9

normalize.Package

}

# produce()

src/header/produce.ts#L13

produce()  =>

Promise<Header>

# render(Header)

src/header/render.tsx#L6

Header

render(Header)  =>

string

# intro

src/intro/index.ts#L1

# Intro

src/intro/produce.ts#L4

{

# intro

src/intro/produce.ts#L5

string

}

# produce()

src/intro/produce.ts#L8

produce()  =>

Promise<Intro>

# render(Intro)

src/intro/render.ts#L3

Intro

render(Intro)  =>

string

Credits

• brotli-size by Erwin Mombay – Get the brotli compressed size of a string or buffer
• decarg by stagas – decorator based cli arguments parser
• get-video-width-height by clearisoft – Get the width and height of a video
• html-jsx by stagas – Extensible jsx type definitions for standard html interfaces.
• image-size by netroy – get dimensions of any image file
• markdown-it by markdown-it – Markdown-it - modern pluggable markdown parser.
• normalize-package-data by GitHub Inc. – Normalizes data that can be found in package.json files.
• typedoc by TypeStrong – Create api documentation for TypeScript projects.

Contributing

Fork or edit and submit a PR.

All contributions are welcome!

License

MIT © 2022 stagas