Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/stagas/dokio

Documentation generator for TypeScript projects
https://github.com/stagas/dokio

api-docs api-documentation documentation-generator readme-generator typescript

Last synced: 15 days ago
JSON representation

Documentation generator for TypeScript projects

Host: GitHub
URL: https://github.com/stagas/dokio
Owner: stagas
License: mit
Created: 2022-04-04T12:10:33.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2022-08-21T06:36:11.000Z (over 2 years ago)
Last Synced: 2024-12-16T20:32:59.223Z (17 days ago)
Topics: api-docs, api-documentation, documentation-generator, readme-generator, typescript
Language: TypeScript
Homepage:
Size: 64.5 KB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        


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](https://npmjs.org/package/brotli-size) by [Erwin Mombay](https://github.com/erwinmombay) – Get the brotli compressed size of a string or buffer

- [decarg](https://npmjs.org/package/decarg) by [stagas](https://github.com/stagas) – decorator based cli arguments parser

- [get-video-width-height](https://npmjs.org/package/get-video-width-height) by [clearisoft](https://github.com/clearisoft) – Get the width and height of a video

- [html-jsx](https://npmjs.org/package/html-jsx) by [stagas](https://github.com/stagas) – Extensible jsx type definitions for standard html interfaces.

- [image-size](https://npmjs.org/package/image-size) by [netroy](http://netroy.in/) – get dimensions of any image file

- [markdown-it](https://npmjs.org/package/markdown-it) by [markdown-it](https://github.com/markdown-it) – Markdown-it - modern pluggable markdown parser.

- [normalize-package-data](https://npmjs.org/package/normalize-package-data) by [GitHub Inc.](https://github.com/npm) – Normalizes data that can be found in package.json files.

- [typedoc](https://npmjs.org/package/typedoc) by [TypeStrong](https://github.com/TypeStrong) – Create api documentation for TypeScript projects.

## Contributing

[Fork](https://github.com/stagas/dokio/fork) or [edit](https://github.dev/stagas/dokio) and submit a PR.

All contributions are welcome!

## License

MIT © 2022 [stagas](https://github.com/stagas)