Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mucsi96/typescript-documentation
Generate markdown API documentation directly from TypeScript source code
https://github.com/mucsi96/typescript-documentation
documentation generate generator markdown typescript
Last synced: 2 months ago
JSON representation
Generate markdown API documentation directly from TypeScript source code
- Host: GitHub
- URL: https://github.com/mucsi96/typescript-documentation
- Owner: mucsi96
- License: mit
- Created: 2019-11-23T21:39:29.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-06-20T20:04:14.000Z (over 2 years ago)
- Last Synced: 2024-10-13T03:12:27.212Z (3 months ago)
- Topics: documentation, generate, generator, markdown, typescript
- Language: TypeScript
- Homepage:
- Size: 964 KB
- Stars: 20
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# typescript-documentation
[](https://www.npmjs.com/package/typescript-documentation)
[](https://github.com/mucsi96/typescript-documentation/actions?query=workflow%3ABuild+branch%3Amaster)
[](https://coveralls.io/github/mucsi96/typescript-documentation?branch=master)
[](https://www.npmjs.com/package/typescript-documentation)
[](https://github.com/mucsi96/typescript-documentation)
Generate markdown API documentation directly from TypeScript source code.
# Usage
```
npm i typescript-documentation
```
```
> typescript-documentation [options]
Options:
-p, --project relative or absolute path to a tsconfig.json file (default: "./tsconfig.json")
-e, --entry entry/main file of project (default: "./src/index.ts")
-o, --output markdown documentation output file location (default: "./docs/README.md")
-h, --help output usage information
```
[Live example output](https://mucsi96.gitbook.io/w3c-webdriver/)
# Documenting variables
_Example input:_
```typescript
/**
* Simple variable description
* line 2
* @see {@link https://test.url.1|Example url 1}
* @see {@link https://test.url.2|Example url 2}
* @example
* example 1 line 1
* example 1 line 2
* @example
* example 2 line 1
* example 2 line 2
*/
export const simpleVariable: number = 1;
```
_Example output:_
## simpleVariable
Simple variable description
line 2
**TYPE**
number
**EXAMPLES**
```typescript
example 1 line 1
example 1 line 2
```
```typescript
example 2 line 1
example 2 line 2
```
**SEE ALSO**
- [Example url 1](https://test.url.1)
- [Example url 2](https://test.url.2)
# Documenting functions
_Example input:_
```typescript
/**
* Simple function description
* line 2
* @see {@link https://test.url.1|Example url 1}
* @see {@link https://test.url.2|Example url 2}
* @example
* example 1 line 1
* example 1 line 2
* @example
* example 2 line 1
* example 2 line 2
* @param a first parameter description
* @param b second parameter description
*/
export function simpleFunction(a: string, b?: number): string {
return a;
}
```
_Example output:_
## simpleFunction(a, b)
Simple function description
line 2
**PARAMETERS**
- `a`: string - first parameter description
- `b?`: number - second parameter description
**RETURNS**
string
**EXAMPLES**
```typescript
example 1 line 1
example 1 line 2
```
```typescript
example 2 line 1
example 2 line 2
```
**SEE ALSO**
- [Example url 1](https://test.url.1)
- [Example url 2](https://test.url.2)
# Documenting classes
_Example input:_
```typescript
/**
* Simple class description
* line 2
* @see {@link https://test.url.1|Example url 1}
* @see {@link https://test.url.2|Example url 2}
* @example
* example 1 line 1
* example 1 line 2
* @example
* example 2 line 1
* example 2 line 2
*/
export class SimpleClass {
/**
* simpleMethod1 description
* line 2
* @see {@link https://test.url.3|Example url 3}
* @see {@link https://test.url.4|Example url 4}
* @example
* example 3 line 1
* example 3 line 2
* @example
* example 4 line 1
* example 4 line 2
*/
public simpleMethod1(): void {
return;
}
/**
* simpleMethod2 description
* line 2
* @param a first parameter description
* @param b second parameter description
*/
public simpleMethod2(a: string, b: number): string {
return a + b;
}
}
```
_Example output:_
## SimpleClass
Simple class description
line 2
**EXAMPLES**
```typescript
example 1 line 1
example 1 line 2
```
```typescript
example 2 line 1
example 2 line 2
```
**SEE ALSO**
- [Example url 1](https://test.url.1)
- [Example url 2](https://test.url.2)
## simpleClass.simpleMethod1()
simpleMethod1 description
line 2
**RETURNS**
void
**EXAMPLES**
```typescript
example 3 line 1
example 3 line 2
```
```typescript
example 4 line 1
example 4 line 2
```
**SEE ALSO**
- [Example url 3](https://test.url.3)
- [Example url 4](https://test.url.4)
## simpleClass.simpleMethod2(a, b)
simpleMethod2 description
line 2
**PARAMETERS**
- `a`: string - first parameter description
- `b`: number - second parameter description
**RETURNS**
string
# Documenting types
_Example input:_
```typescript
/**
* Simple type description
* line 2
* @see {@link https://test.url.1|Example url 1}
* @see {@link https://test.url.2|Example url 2}
* @example
* example 1 line 1
* example 1 line 2
* @example
* example 2 line 1
* example 2 line 2
*/
export type SimpleType = {
/**
* first property description
*/
a: string;
/**
* second property description
*/
b?: number;
};
```
_Example output:_
## SimpleType
Simple type description
line 2
**PROPERTIES**
- `a`: string - first property description
- `b?`: number - second property description
**EXAMPLES**
```typescript
example 1 line 1
example 1 line 2
```
```typescript
example 2 line 1
example 2 line 2
```
**SEE ALSO**
- [Example url 1](https://test.url.1)
- [Example url 2](https://test.url.2)
# Documenting enumerations
_Example input:_
```typescript
/**
* Simple enumeration description
* line 2
* @see {@link https://test.url.1|Example url 1}
* @see {@link https://test.url.2|Example url 2}
* @example
* example 1 line 1
* example 1 line 2
* @example
* example 2 line 1
* example 2 line 2
*/
export enum SimpleEnum {
ONE,
TWO
}
```
_Example output:_
## SimpleEnum
Simple enumeration description
line 2
**POSSIBLE VALUES**
- `ONE`
- `TWO`
**EXAMPLES**
```typescript
example 1 line 1
example 1 line 2
```
```typescript
example 2 line 1
example 2 line 2
```
**SEE ALSO**
- [Example url 1](https://test.url.1)
- [Example url 2](https://test.url.2)