forked from SoftwareBrothers/better-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Wojciech Krysiak
authored and
Wojciech Krysiak
committed
Sep 7, 2020
1 parent
fa82beb
commit 418fdf7
Showing
8 changed files
with
482 additions
and
230 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
"use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
export type NavButton = { | ||
label: string; | ||
href: string; | ||
target: string; | ||
className?: string; | ||
} | ||
|
||
export type NavLink = { | ||
label: string; | ||
href: string; | ||
className?: string; | ||
} | ||
|
||
export type OgTags = { | ||
/** | ||
* @ogTitle | ||
* @ogDescription | ||
* @ogImage | ||
*/ | ||
title: string; | ||
description: string; | ||
image: string; | ||
} | ||
|
||
export type BetterDocsConfig = { | ||
/** | ||
* Path to the landing page | ||
*/ | ||
landing?: string; | ||
/** | ||
* Logo | ||
*/ | ||
logo?: string; | ||
/** | ||
* Page Title | ||
*/ | ||
title?: string; | ||
ogTags: OgTags; | ||
/** | ||
* Component config | ||
*/ | ||
component?: { | ||
/** | ||
* Wrapping Component | ||
*/ | ||
wrapper: string; | ||
}; | ||
/** | ||
* Tracking code | ||
*/ | ||
trackingCode?: string; | ||
/** | ||
* Custom text injected to the HEAD | ||
*/ | ||
head?: string; | ||
|
||
/** | ||
* NavButtons showed in the TOP section | ||
*/ | ||
navButtons: Array<NavButton>; | ||
/** | ||
* Navigation links | ||
*/ | ||
navLinks: Array<NavLink>; | ||
} |
Oops, something went wrong.