Skip to content

Commit 0a3a257

Browse files
twlitetwlite
committed
chore: release 0.3.0
1 parent 515b36b commit 0a3a257

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+3031
-920
lines changed

‎.yarn/releases/yarn-4.5.3.cjs

+934
Large diffs are not rendered by default.

‎.yarnrc.yml

+2
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
nodeLinker: node-modules
2+
enableGlobalCache: false
3+
yarnPath: .yarn/releases/yarn-4.5.3.cjs

‎README.md

+29-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ TypeScript documentation generator on steroids 💉. MicroDocgen is built on top
44

55
## TODO
66

7-
- Static site generation
8-
- More options
9-
- CLI
7+
- Static site generation
8+
- More options
9+
- CLI
1010

1111
## Installation
1212

@@ -34,3 +34,29 @@ await createDocumentation({
3434
custom: [...]
3535
});
3636
```
37+
38+
## CLI usage
39+
40+
You need to have `./micro-docgen.json` file in your project root.
41+
42+
```json
43+
{
44+
"input": ["src"],
45+
"output": "docs",
46+
"tsconfigPath": "./tsconfig.json",
47+
"markdown": true,
48+
"jsonName": "docs.json"
49+
}
50+
```
51+
52+
Then run:
53+
54+
```sh
55+
$ docgen
56+
```
57+
58+
or
59+
60+
```sh
61+
$ micro-docgen
62+
```

‎bin/index.js

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#!/usr/bin/env node
2+
3+
const { createCommandLine } = require('../dist/index.js');
4+
5+
createCommandLine(process.argv)

‎docs/docs.json

+1-1
Large diffs are not rendered by default.

‎docs/markdown/classes/AbstractSerializer.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: AbstractSerializer
3+
description: No description provided
4+
---
5+
6+
7+
## AbstractSerializer
8+
9+
10+
```typescript
11+
AbstractSerializer(declaration)
12+
```
13+
| Parameter | Type | Optional |
14+
| ----------- | ----------- | ----------- |
15+
| declaration | DeclarationReflection | ❌ |
16+
17+
18+
## Properties
19+
### public declaration: any
20+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/serializers/AbstractSerializer.ts#L4)
21+
22+
## Methods
23+
### public serialize(): [void](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined)
24+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/serializers/AbstractSerializer.ts#L6)

‎docs/markdown/classes/ClassSerializer.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
title: ClassSerializer
3+
description: No description provided
4+
---
5+
6+
7+
## ClassSerializer extends [AbstractSerializer](/docs/markdown/classes/AbstractSerializer.md)
8+
9+
10+
```typescript
11+
ClassSerializer(declaration)
12+
```
13+
| Parameter | Type | Optional |
14+
| ----------- | ----------- | ----------- |
15+
| declaration | DeclarationReflection | ❌ |
16+
17+
18+
## Properties
19+
### public declaration: any
20+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/serializers/AbstractSerializer.ts#L4)
21+
22+
## Methods
23+
### public parseMethod(decl): DocumentedClassMethod
24+
| Parameter | Type | Optional |
25+
| ----------- | ----------- | ----------- |
26+
| decl | DeclarationReflection | ❌ |
27+
28+
29+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/serializers/ClassSerializer.ts#L185)
30+
### public parseParameter(decl): DocumentedParameter
31+
| Parameter | Type | Optional |
32+
| ----------- | ----------- | ----------- |
33+
| decl | TypeParameterReflection | ❌ |
34+
35+
36+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/serializers/ClassSerializer.ts#L226)
37+
### public parseProperties(decl): DocumentedClassProperty
38+
| Parameter | Type | Optional |
39+
| ----------- | ----------- | ----------- |
40+
| decl | DeclarationReflection | ❌ |
41+
42+
43+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/serializers/ClassSerializer.ts#L123)
44+
### public serialize(): DocumentedClass
45+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/serializers/ClassSerializer.ts#L69)

‎docs/markdown/classes/FunctionSerializer.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: FunctionSerializer
3+
description: No description provided
4+
---
5+
6+
7+
## FunctionSerializer extends [AbstractSerializer](/docs/markdown/classes/AbstractSerializer.md)
8+
9+
10+
```typescript
11+
FunctionSerializer(declaration)
12+
```
13+
| Parameter | Type | Optional |
14+
| ----------- | ----------- | ----------- |
15+
| declaration | DeclarationReflection | ❌ |
16+
17+
18+
## Properties
19+
### public declaration: any
20+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/serializers/AbstractSerializer.ts#L4)
21+
22+
## Methods
23+
### public parseParameter(decl): DocumentedParameter
24+
| Parameter | Type | Optional |
25+
| ----------- | ----------- | ----------- |
26+
| decl | TypeParameterReflection | ❌ |
27+
28+
29+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/serializers/FunctionSerializer.ts#L51)
30+
### public serialize(): DocumentedClassMethod
31+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/serializers/FunctionSerializer.ts#L9)

‎docs/markdown/classes/MarkdownGenerator.md

+101
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
---
2+
title: MarkdownGenerator
3+
description: No description provided
4+
---
5+
6+
7+
## MarkdownGenerator
8+
9+
10+
```typescript
11+
MarkdownGenerator(options)
12+
```
13+
| Parameter | Type | Optional |
14+
| ----------- | ----------- | ----------- |
15+
| options | MarkdownGeneratorMdBuilderOptions | ❌ |
16+
17+
18+
## Properties
19+
### public linker: any
20+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/generators/MarkdownGenerator.ts#L26)
21+
### public options: any
22+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/generators/MarkdownGenerator.ts#L28)
23+
24+
## Methods
25+
### public getClassHeading(c): [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
26+
| Parameter | Type | Optional |
27+
| ----------- | ----------- | ----------- |
28+
| c | DocumentedClass | ❌ |
29+
30+
31+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/generators/MarkdownGenerator.ts#L44)
32+
### public getCtor(c): [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
33+
| Parameter | Type | Optional |
34+
| ----------- | ----------- | ----------- |
35+
| c | DocumentedClassConstructor | ❌ |
36+
37+
38+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/generators/MarkdownGenerator.ts#L52)
39+
### public getFunctions(m): [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
40+
| Parameter | Type | Optional |
41+
| ----------- | ----------- | ----------- |
42+
| m | DocumentedClassMethod | ❌ |
43+
44+
45+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/generators/MarkdownGenerator.ts#L269)
46+
### public getHeaders(value): [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
47+
| Parameter | Type | Optional |
48+
| ----------- | ----------- | ----------- |
49+
| value | DocumentedClass | DocumentedClassMethod | DocumentedTypes | ❌ |
50+
51+
52+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/generators/MarkdownGenerator.ts#L32)
53+
### public getMarkdown(c): [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
54+
| Parameter | Type | Optional |
55+
| ----------- | ----------- | ----------- |
56+
| c | DocumentedClass | ❌ |
57+
58+
59+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/generators/MarkdownGenerator.ts#L158)
60+
### public getMethods(methods): [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
61+
| Parameter | Type | Optional |
62+
| ----------- | ----------- | ----------- |
63+
| methods | [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)\<DocumentedClassMethod> | ❌ |
64+
65+
66+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/generators/MarkdownGenerator.ts#L200)
67+
### public getProperties(properties): [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
68+
| Parameter | Type | Optional |
69+
| ----------- | ----------- | ----------- |
70+
| properties | [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)\<DocumentedClassProperty> | ❌ |
71+
72+
73+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/generators/MarkdownGenerator.ts#L173)
74+
### public getTypeMarkdown(t): [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
75+
| Parameter | Type | Optional |
76+
| ----------- | ----------- | ----------- |
77+
| t | DocumentedTypes | ❌ |
78+
79+
80+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/generators/MarkdownGenerator.ts#L115)
81+
### public transformClass(classes): [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)\<MarkdownGeneratorMarkdownBuild>
82+
| Parameter | Type | Optional |
83+
| ----------- | ----------- | ----------- |
84+
| classes | [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)\<DocumentedClass> | ❌ |
85+
86+
87+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/generators/MarkdownGenerator.ts#L85)
88+
### public transformFunctions(types): [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)\<MarkdownGeneratorMarkdownBuild>
89+
| Parameter | Type | Optional |
90+
| ----------- | ----------- | ----------- |
91+
| types | [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)\<DocumentedClassMethod> | ❌ |
92+
93+
94+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/generators/MarkdownGenerator.ts#L95)
95+
### public transformTypes(types): [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)\<MarkdownGeneratorMarkdownBuild>
96+
| Parameter | Type | Optional |
97+
| ----------- | ----------- | ----------- |
98+
| types | [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)\<DocumentedTypes> | ❌ |
99+
100+
101+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/generators/MarkdownGenerator.ts#L105)

‎docs/markdown/classes/TypesSerializer.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: TypesSerializer
3+
description: No description provided
4+
---
5+
6+
7+
## TypesSerializer extends [AbstractSerializer](/docs/markdown/classes/AbstractSerializer.md)
8+
9+
10+
```typescript
11+
TypesSerializer(declaration)
12+
```
13+
| Parameter | Type | Optional |
14+
| ----------- | ----------- | ----------- |
15+
| declaration | DeclarationReflection | ❌ |
16+
17+
18+
## Properties
19+
### public declaration: any
20+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/serializers/AbstractSerializer.ts#L4)
21+
22+
## Methods
23+
### public serialize(): DocumentedTypes
24+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/serializers/TypesSerializer.ts#L27)

‎docs/markdown/enums/DebugLogLevel.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: DebugLogLevel
3+
description: List of known log levels. Used to specify the urgency of a log message.
4+
---
5+
6+
## DebugLogLevel
7+
8+
List of known log levels. Used to specify the urgency of a log message.
9+
10+
| Property | Type | Value |
11+
| ----------- | ----------- | ----------- |
12+
| Error | 3 | N/A |
13+
| Info | 1 | N/A |
14+
| None | 4 | N/A |
15+
| Verbose | 0 | N/A |
16+
| Warn | 2 | N/A |

‎docs/markdown/functions/blockquote.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: blockquote
3+
description: No description provided
4+
---
5+
6+
7+
### blockquote(src): \`> \$\{T}\`
8+
9+
| Parameter | Type | Optional |
10+
| ----------- | ----------- | ----------- |
11+
| src | T | ❌ |
12+
13+
14+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/utils/md.ts#L70)

‎docs/markdown/functions/bold.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: bold
3+
description: No description provided
4+
---
5+
6+
7+
### bold(src): \`\*\*\$\{T}\`
8+
9+
| Parameter | Type | Optional |
10+
| ----------- | ----------- | ----------- |
11+
| src | T | ❌ |
12+
13+
14+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/utils/md.ts#L39)

‎docs/markdown/functions/code.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: code
3+
description: No description provided
4+
---
5+
6+
7+
### code(src): \`\`\$\{T}\`
8+
9+
| Parameter | Type | Optional |
10+
| ----------- | ----------- | ----------- |
11+
| src | T | ❌ |
12+
13+
14+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/utils/md.ts#L31)

‎docs/markdown/functions/codeBlock.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: codeBlock
3+
description: No description provided
4+
---
5+
6+
7+
### codeBlock(src, lang?): \`\`\`\`
8+
\$\{T}\`\`\`\`\`\$\{U}\`\`\`\`\`\$\{T}\`
9+
10+
| Parameter | Type | Optional |
11+
| ----------- | ----------- | ----------- |
12+
| src | T | ❌ |
13+
| lang | U | ✅ |
14+
15+
16+
- [Source](https://github.com/neplextech/micro-docgen/blob/515b36b40a80a8da0e52785839d6336deb90e3f3/src/utils/md.ts#L35)

‎docs/markdown/functions/createCommandLine.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: createCommandLine
3+
description: No description provided
4+
---
5+
6+
7+
### createCommandLine(args): [void](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined)
8+
9+
| Parameter | Type | Optional |
10+
| ----------- | ----------- | ----------- |
11+
| args | [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)\<[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)> | ❌ |

0 commit comments

Comments
 (0)