Back to Gh Dash

How to Configure

docs/src/content/docs/configuration/index.mdx

4.23.22.7 KB
Original Source

import { Aside, LinkCard, CardGrid } from "@astrojs/starlight/components";

dash has extensive configuration options.

  • Modify the default config which is usually under $HOME/.config/gh-dash/config.yml.
  • Use the --config flag to specify a different configuration file.
  • Create a .gh-dash.yml file in a repo for project specific configuration.
<details> <summary>Give me more details!</summary> Using the following logic: 1. If `$GH_DASH_CONFIG` is a non-empty string, `dash` will use this file for its configuration. 2. If `$GH_DASH_CONFIG` isn't set and you're in a git repository, it will look for `.gh-dash.yml` or `.gh-dash.yaml` in the repository root. 3. If neither of the above applies, then: - If `$XDG_CONFIG_HOME` is a non-empty string, the default path is `$XDG_CONFIG_HOME/gh-dash/config.yml`. - If `$XDG_CONFIG_HOME` isn't set, then: - On Linux and macOS systems, the default path is `$HOME/.config/gh-dash/config.yml`. - On Windows systems, the default path is `%USERPROFILE%\.config\gh-dash\config.yml`. </details>
<Aside type="tip"> Just want a few examples for inspiration? Check out the [examples](./examples). </Aside>

Options

The configuration for dash is schematized. The pages in this section list the configuration options, their defaults, and how you can use them.

Schema

Documentation and schema for the configuration of your GitHub dashboard.

<CardGrid> <LinkCard title="Schema" href="./schema" description="Configure your IDE to autocomplete when editing the config file" /> <LinkCard title="Defaults" href="./defaults" description="Documentation for the default setting options for your GitHub dashboard." /> <LinkCard title="Searching" href="./searching" description="How to search and filter issues and prs" /> <LinkCard title="PR Section" href="./pr-section" description="Documentation for configuring the PR sections of your GitHub dashboard." /> <LinkCard title="Issue Section" href="./issue-section" description="Documentation for configuring the issue's sections of your GitHub dashboard." /> <LinkCard title="Keybindings" href="./keybindings" description="Documentation for defining commands for your GitHub dashboard." /> <LinkCard title="Layout" href="./layout/options" description="Documentation for configuring your GitHub dashboard’s layout." /> <LinkCard title="Theme" href="./theme" description="Documentation for configuring your GitHub dashboard’s theme." /> <LinkCard title="Reusing Settings" href="./reusing.mdx" description="Define global settings that will always be applied" /> </CardGrid>