@cparra/apexdocs 3.4.1 → 3.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -17,7 +17,7 @@ create a documentation site that fits your needs, hosted in any static web hosti
17
17
  ApexDocs generates Markdown files, which can be integrated into any Static Site Generation (SSG) engine,
18
18
  (e.g. Jekyll, Vitepress, Hugo, Docosaurus, etc.) to create a documentation site that fits your needs.
19
19
 
20
- This gives you the flexibility to create beautiful leveraging your preferred SSG engine, which
20
+ This gives you the flexibility to create beautiful sites by leveraging your preferred SSG engine, which
21
21
  usually provides a wide range of themes, dark mode support, and other features out of the box.
22
22
 
23
23
  <div align="center">
@@ -1,7 +1,7 @@
1
1
  #!/usr/bin/env node
2
2
  'use strict';
3
3
 
4
- var logger$1 = require('../logger-BJXlA0YD.js');
4
+ var logger$1 = require('../logger-C1IFVWQ7.js');
5
5
  var module$1 = require('module');
6
6
  var cosmiconfig = require('cosmiconfig');
7
7
  var E = require('fp-ts/Either');
package/dist/index.d.ts CHANGED
@@ -11,9 +11,8 @@ type LinkingStrategy =
11
11
  // No logic will be applied, the reference path will be used as is.
12
12
  | 'none';
13
13
 
14
- type UserDefinedMarkdownConfig = {
14
+ type CliConfigurableMarkdownConfig = {
15
15
  sourceDir: string;
16
- targetGenerator: 'markdown';
17
16
  targetDir: string;
18
17
  scope: string[];
19
18
  namespace?: string;
@@ -22,11 +21,15 @@ type UserDefinedMarkdownConfig = {
22
21
  sortAlphabetically: boolean;
23
22
  includeMetadata: boolean;
24
23
  linkingStrategy: LinkingStrategy;
25
- excludeTags: string[];
26
24
  referenceGuideTitle: string;
27
- /** Glob patterns to exclude files from the documentation. */
25
+ };
26
+
27
+ type UserDefinedMarkdownConfig = {
28
+ targetGenerator: 'markdown' /** Glob patterns to exclude files from the documentation. */;
29
+ excludeTags: string[];
28
30
  exclude: string[];
29
- } & Partial<ConfigurableHooks>;
31
+ } & CliConfigurableMarkdownConfig &
32
+ Partial<ConfigurableHooks>;
30
33
 
31
34
  type UserDefinedOpenApiConfig = {
32
35
  targetGenerator: 'openapi';
package/dist/index.js CHANGED
@@ -1,6 +1,6 @@
1
1
  'use strict';
2
2
 
3
- var logger = require('./logger-BJXlA0YD.js');
3
+ var logger = require('./logger-C1IFVWQ7.js');
4
4
  var E = require('fp-ts/Either');
5
5
  require('fp-ts/function');
6
6
  require('fp-ts/TaskEither');