Every MinimalDocs site needs a docs.json file with the core configuration settings. Learn more about the properties below.
Properties
namestringrequiredName of your project. Used for the global title.
Example: minimaldocs
navigationNavigation[]requiredAn array of groups with all the pages within that group
Navigation
groupstringThe name of the group.
Example: Settings
pagesstring[]The relative paths to the markdown files that will serve as pages.
Example: ["customization", "page"]
logostring or objectPath to logo image or object with path to "light" and "dark" mode logo images
Logo
lightstringPath to the logo in light mode
darkstringPath to the logo in dark mode
hrefstringWhere clicking on the logo links you to
faviconstringPath to the favicon image
colorsColorsHex color codes for your global theme
Colors
primarystringrequiredThe primary color. Used for most often for highlighted content, section headers, accents, in light mode
lightstringThe primary color for dark mode. Used for most often for highlighted content, section headers, accents, in dark mode
darkstringThe primary color for important buttons
backgroundobjectThe color of the background in both light and dark mode
Object
lightstringrequiredThe hex color code of the background in light mode
darkstringrequiredThe hex color code of the background in dark mode
topbarLinksTopbarLink[]Array of names and urls of links you want to include in the topbar
TopbarLink
namestringThe name of the button.
Example: Contact us
urlstringThe url once you click on the button. Example: https://minimaldocs.com/docs
topbarCtaButtonCall to ActionTopbar Call to Action
type"link" or "github"Link shows a button. GitHub shows the repo information at the url provided including the number of GitHub stars.
urlstringIf link: What the button links to.
If github: Link to the repository to load GitHub information from.
namestringText inside the button. Only required if type is a link.
versionsstring[]Array of version names. Only use this if you want to show different versions of docs with a dropdown in the navigation bar.
anchorsAnchor[]An array of the anchors, includes the icon, color, and url.
Anchor
iconstringThe Font Awesome icon used to feature the anchor.
Example: comments
namestringThe name of the anchor label.
Example: Community
urlstringThe start of the URL that marks what pages go in the anchor. Generally, this is the name of the folder you put your pages in.
colorstringThe hex color of the anchor icon background. Can also be a gradient if you pass an object with the properties from and to that are each a hex color.
versionstringUsed if you want to hide an anchor until the correct docs version is selected.
isDefaultHiddenbooleanPass true if you want to hide the anchor until you directly link someone to docs inside it.
iconTypestringOne of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin"
topAnchorObjectOverride the default configurations for the top-most anchor.
Object
namestringThe name of the top-most anchor
iconstringFont Awesome icon.
iconTypestringOne of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin"
tabsTabs[]An array of navigational tabs.
Tabs
namestringThe name of the tab label.
urlstringThe start of the URL that marks what pages go in the tab. Generally, this is the name of the folder you put your pages in.
apiAPIConfiguration for API settings. Learn more about API pages at API Components.
API
baseUrlstringThe base url for all API endpoints. If baseUrl is an array, it will enable for multiple base url
options that the user can toggle.
authAuthAuth
method"bearer" | "basic" | "key"The authentication strategy used for all API endpoints.
namestringThe name of the authentication parameter used in the API playground.
If method is basic, the format should be [usernameName]:[passwordName]
inputPrefixstringThe default value that's designed to be a prefix for the authentication input field.
E.g. If an inputPrefix of AuthKey would inherit the default input result of the authentication field as AuthKey.
playgroundPlaygroundConfigurations for the API playground
Playground
mode"show" | "simple" | "hide"Whether the playground is showing, hidden, or only displaying the endpoint with no added user interactivity simple
Learn more at the playground guides
maintainOrderbooleanEnabling this flag ensures that key ordering in OpenAPI pages matches the key ordering defined in the OpenAPI file.
openapistring | string[]A string or an array of strings of URL(s) or relative path(s) pointing to your OpenAPI file.
Examples:
footerSocialsFooterSocialsAn object of social media accounts where the key:property pair represents the social media platform and the account url.
Example:
FooterSocials
[key]stringOne of the following values website, facebook, x, discord, slack, github, linkedin, instagram, hacker-news
Example: x
propertystringThe URL to the social platform.
Example: https://x.com/minimaldocs
feedbackFeedbackConfigurations to enable feedback buttons
Feedback
suggestEditbooleanEnables a button to allow users to suggest edits via pull requests
raiseIssuebooleanEnables a button to allow users to raise an issue about the documentation
modeToggleModeToggleCustomize the dark mode toggle.
ModeToggle
default"light" or "dark"Set if you always want to show light or dark mode for new users. When not set, we default to the same mode as the user's operating system.
isHiddenbooleanSet to true to hide the dark/light mode toggle. You can combine isHidden with default to force your docs to only use light or dark mode. For example: