Skip to content

Commit 44846e6

Browse files
ilg-ulilg-ul
committed
configuration navbarFilePath & navbarLabel (breaking change)
1 parent d2c767b commit 44846e6

49 files changed

Lines changed: 264 additions & 206 deletions

Some content is hidden

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

‎api-extractor/doxygen2docusaurus.api.json‎

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8997,12 +8997,12 @@
89978997
},
89988998
{
89998999
"kind": "Property",
9000-
"canonicalReference": "@xpack/doxygen2docusaurus!CliOptions#navbarDropdownFilePath:member",
9000+
"canonicalReference": "@xpack/doxygen2docusaurus!CliOptions#navbarFilePath:member",
90019001
"docComment": "/**\n * Relative to the current website folder.\n */\n",
90029002
"excerptTokens": [
90039003
{
90049004
"kind": "Content",
9005-
"text": "navbarDropdownFilePath: "
9005+
"text": "navbarFilePath: "
90069006
},
90079007
{
90089008
"kind": "Content",
@@ -9016,7 +9016,7 @@
90169016
"isReadonly": false,
90179017
"isOptional": false,
90189018
"releaseTag": "Public",
9019-
"name": "navbarDropdownFilePath",
9019+
"name": "navbarFilePath",
90209020
"propertyTypeTokenRange": {
90219021
"startIndex": 1,
90229022
"endIndex": 2
@@ -9027,12 +9027,12 @@
90279027
},
90289028
{
90299029
"kind": "Property",
9030-
"canonicalReference": "@xpack/doxygen2docusaurus!CliOptions#navbarDropdownLabel:member",
9030+
"canonicalReference": "@xpack/doxygen2docusaurus!CliOptions#navbarLabel:member",
90319031
"docComment": "/**\n * Short text to be displayed in the top navigation bar.\n */\n",
90329032
"excerptTokens": [
90339033
{
90349034
"kind": "Content",
9035-
"text": "navbarDropdownLabel: "
9035+
"text": "navbarLabel: "
90369036
},
90379037
{
90389038
"kind": "Content",
@@ -9046,7 +9046,37 @@
90469046
"isReadonly": false,
90479047
"isOptional": false,
90489048
"releaseTag": "Public",
9049-
"name": "navbarDropdownLabel",
9049+
"name": "navbarLabel",
9050+
"propertyTypeTokenRange": {
9051+
"startIndex": 1,
9052+
"endIndex": 2
9053+
},
9054+
"isStatic": false,
9055+
"isProtected": false,
9056+
"isAbstract": false
9057+
},
9058+
{
9059+
"kind": "Property",
9060+
"canonicalReference": "@xpack/doxygen2docusaurus!CliOptions#navbarPosition:member",
9061+
"docComment": "/**\n * Where the menu is to be displayed, left or right.\n */\n",
9062+
"excerptTokens": [
9063+
{
9064+
"kind": "Content",
9065+
"text": "navbarPosition: "
9066+
},
9067+
{
9068+
"kind": "Content",
9069+
"text": "'left' | 'right'"
9070+
},
9071+
{
9072+
"kind": "Content",
9073+
"text": ";"
9074+
}
9075+
],
9076+
"isReadonly": false,
9077+
"isOptional": false,
9078+
"releaseTag": "Public",
9079+
"name": "navbarPosition",
90509080
"propertyTypeTokenRange": {
90519081
"startIndex": 1,
90529082
"endIndex": 2

‎api-extractor/doxygen2docusaurus.api.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -526,8 +526,9 @@ export class CliOptions {
526526
imagesFolderPath: string;
527527
listPagesAtTop: boolean;
528528
mainPageTitle: string;
529-
navbarDropdownFilePath: string;
530-
navbarDropdownLabel: string;
529+
navbarFilePath: string;
530+
navbarLabel: string;
531+
navbarPosition: 'left' | 'right';
531532
originalPagesNote: string;
532533
// (undocumented)
533534
parse(): Promise<void>;

‎api-extractor/markdown/doxygen2docusaurus.clioptions.md‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@ The title to be displayed on the main page.
318318
</td></tr>
319319
<tr><td>
320320

321-
[navbarDropdownFilePath](./doxygen2docusaurus.clioptions.navbardropdownfilepath.md)
321+
[navbarFilePath](./doxygen2docusaurus.clioptions.navbarfilepath.md)
322322

323323

324324
</td><td>
@@ -337,7 +337,7 @@ Relative to the current website folder.
337337
</td></tr>
338338
<tr><td>
339339

340-
[navbarDropdownLabel](./doxygen2docusaurus.clioptions.navbardropdownlabel.md)
340+
[navbarLabel](./doxygen2docusaurus.clioptions.navbarlabel.md)
341341

342342

343343
</td><td>
@@ -353,6 +353,25 @@ string
353353
Short text to be displayed in the top navigation bar.
354354

355355

356+
</td></tr>
357+
<tr><td>
358+
359+
[navbarPosition](./doxygen2docusaurus.clioptions.navbarposition.md)
360+
361+
362+
</td><td>
363+
364+
365+
</td><td>
366+
367+
'left' \| 'right'
368+
369+
370+
</td><td>
371+
372+
Where the menu is to be displayed, left or right.
373+
374+
356375
</td></tr>
357376
<tr><td>
358377

api-extractor/markdown/doxygen2docusaurus.clioptions.navbardropdownfilepath.md renamed to api-extractor/markdown/doxygen2docusaurus.clioptions.navbarfilepath.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [@xpack/doxygen2docusaurus](./doxygen2docusaurus.md) &gt; [CliOptions](./doxygen2docusaurus.clioptions.md) &gt; [navbarDropdownFilePath](./doxygen2docusaurus.clioptions.navbardropdownfilepath.md)
3+
[Home](./index.md) &gt; [@xpack/doxygen2docusaurus](./doxygen2docusaurus.md) &gt; [CliOptions](./doxygen2docusaurus.clioptions.md) &gt; [navbarFilePath](./doxygen2docusaurus.clioptions.navbarfilepath.md)
44

5-
## CliOptions.navbarDropdownFilePath property
5+
## CliOptions.navbarFilePath property
66

77
Relative to the current website folder.
88

99
**Signature:**
1010

1111
```typescript
12-
navbarDropdownFilePath: string;
12+
navbarFilePath: string;
1313
```

api-extractor/markdown/doxygen2docusaurus.clioptions.navbardropdownlabel.md renamed to api-extractor/markdown/doxygen2docusaurus.clioptions.navbarlabel.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [@xpack/doxygen2docusaurus](./doxygen2docusaurus.md) &gt; [CliOptions](./doxygen2docusaurus.clioptions.md) &gt; [navbarDropdownLabel](./doxygen2docusaurus.clioptions.navbardropdownlabel.md)
3+
[Home](./index.md) &gt; [@xpack/doxygen2docusaurus](./doxygen2docusaurus.md) &gt; [CliOptions](./doxygen2docusaurus.clioptions.md) &gt; [navbarLabel](./doxygen2docusaurus.clioptions.navbarlabel.md)
44

5-
## CliOptions.navbarDropdownLabel property
5+
## CliOptions.navbarLabel property
66

77
Short text to be displayed in the top navigation bar.
88

99
**Signature:**
1010

1111
```typescript
12-
navbarDropdownLabel: string;
12+
navbarLabel: string;
1313
```

‎api-extractor/markdown/doxygen2docusaurus.clioptions.navbarposition.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@xpack/doxygen2docusaurus](./doxygen2docusaurus.md) &gt; [CliOptions](./doxygen2docusaurus.clioptions.md) &gt; [navbarPosition](./doxygen2docusaurus.clioptions.navbarposition.md)
4+
5+
## CliOptions.navbarPosition property
6+
7+
Where the menu is to be displayed, left or right.
8+
9+
**Signature:**
10+
11+
```typescript
12+
navbarPosition: 'left' | 'right';
13+
```

‎dist/docusaurus/cli-options.js‎

Lines changed: 6 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/docusaurus/generator.d.ts‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
11
import { Workspace } from './workspace.js';
22
import { CliOptions } from './cli-options.js';
3+
import type { SidebarCategory, NavbarItem } from './types.js';
34
import type { CompoundBase } from './view-model/compound-base-vm.js';
45
export declare class DocusaurusGenerator {
56
workspace: Workspace;
67
options: CliOptions;
78
constructor(workspace: Workspace);
89
run(): Promise<number>;
910
prepareOutputFolder(): Promise<void>;
10-
generateSidebarFile(): Promise<void>;
11-
generateMenuFile(): Promise<void>;
11+
generateSidebarCategory(): SidebarCategory;
12+
writeSidebarFile(sidebarCategory: SidebarCategory): Promise<void>;
13+
generateNavbarItem(): NavbarItem;
14+
writeNavbarFile(navbarItem: NavbarItem): Promise<void>;
1215
generateCollectionsIndexDotMdFiles(): Promise<void>;
1316
generateTopIndexDotMdFile(): Promise<void>;
14-
generatePerInitialsIndexMdFiles(): Promise<void>;
15-
generatePages(): Promise<void>;
17+
generatePerInitialsIndexDotMdFiles(): Promise<void>;
18+
generateMdFiles(): Promise<void>;
1619
generatePage(compound: CompoundBase): Promise<void>;
1720
generateCompatibilityRedirectFiles(): Promise<void>;
1821
private generateRedirectFile;

‎dist/docusaurus/generator.d.ts.map‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/docusaurus/generator.js‎

Lines changed: 40 additions & 42 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)