The D-Sports docs site at docs.d-sports.org is driven by a single docs.json file in this repo. It controls the site name, logo, colors, navigation, footer, and more. Below are the main properties we use and their meanings for this project.
Properties Name of the site. Used for the global title (e.g. in the browser tab and header). Example: D-Sports Docs
An array of groups with all the pages within that group The name of the group. Example: Getting started
The relative paths to the MDX files (no extension). Example: ["index", "quickstart", "repositories/ecosystem-overview"]
Path to logo image or object with path to “light” and “dark” mode logo images Path to the logo in light mode
Path to the logo in dark mode
Where clicking on the logo links you to
Path to the favicon image
Hex color codes for your global theme The primary color. Used for most often for highlighted content, section
headers, accents, in light mode
The primary color for dark mode. Used for most often for highlighted
content, section headers, accents, in dark mode
The primary color for important buttons
The color of the background in both light and dark mode The hex color code of the background in light mode
The hex color code of the background in dark mode
Array of names and urls of links you want to include in the topbar The name of the button. Example: Contact us
The url once you click on the button. Example: https://docs.d-sports.org
Show Topbar Call to Action
type
"link" or "github"
default: "link"
Link shows a button. GitHub shows the repo information at the url provided including the number of GitHub stars.
If link: What the button links to. If github: Link to the repository to load GitHub information from.
Text inside the button. Only required if type is a link.
Array of version names. Only use this if you want to show different versions
of docs with a dropdown in the navigation bar.
An array of the anchors, includes the icon, color, and url. The Font Awesome icon used to feature the anchor. Example: comments The name of the anchor label. Example: Community
The 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.
The 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.
Used if you want to hide an anchor until the correct docs version is selected.
Pass true if you want to hide the anchor until you directly link someone to docs inside it.
One of: “brands”, “duotone”, “light”, “sharp-solid”, “solid”, or “thin”
Override the default configurations for the top-most anchor. name
string
default: "Documentation"
The name of the top-most anchor
icon
string
default: "book-open"
Font Awesome icon.
One of: “brands”, “duotone”, “light”, “sharp-solid”, “solid”, or “thin”
An array of navigational tabs. The name of the tab label.
The 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.
Configuration for API settings. Learn more about API pages at API Components . The base url for all API endpoints. If baseUrl is an array, it will enable for multiple base url
options that the user can toggle.
method
"bearer" | "basic" | "key"
The authentication strategy used for all API endpoints.
The name of the authentication parameter used in the API playground. If method is basic, the format should be [usernameName]:[passwordName]
The 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.
Configurations for the API playground mode
"show" | "simple" | "hide"
default: "show"
Whether the playground is showing, hidden, or only displaying the endpoint with no added user interactivity simple Learn more at the playground guides Enabling this flag ensures that key ordering in OpenAPI pages matches the key ordering defined in the OpenAPI file. This behavior will soon be enabled by default, at which point this field will be deprecated.
A string or an array of strings of URL(s) or relative path(s) pointing to your
OpenAPI file. Examples: "openapi" : "https://example.com/openapi.json"
An object of social media accounts where the key:property pair represents the social media platform and the account url. Example: { "x" : "https://x.com/dsportsorg" , "website" : "https://d-sports.org" }
One of the following values website, facebook, x, discord, slack, github, linkedin, instagram, hacker-news Example: x
The URL to the social platform. Example: https://x.com/dsportsorg
Configurations to enable feedback buttons Enables a button to allow users to suggest edits via pull requests
Enables a button to allow users to raise an issue about the documentation
Customize the dark mode toggle. 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.
Set 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: Only Dark Mode
Only Light Mode
"modeToggle" : { "default" : "dark" , "isHidden" : true }
A background image to be displayed behind every page. See example with
Infisical and FRPC . 