great-docs config

Generate a documentation configuration file

great-docs config [OPTIONS]

Creates docs/great-docs.yml with all available options documented. The generated file contains commented examples for each setting.

Full --help output

Usage: great-docs config [OPTIONS]

  Generate a documentation configuration file

  Creates 'docs/great-docs.yml' with all available options documented. The
  generated file contains commented examples for each setting.

  Examples:
    great-docs config                     # Generate docs/great-docs.yml
    great-docs config --force             # Overwrite existing file
    great-docs config --project-path ../pkg

Options:
  --project-path DIRECTORY  Path to your project root directory (default:
                            current directory)
  --force                   Overwrite existing great-docs.yml without
                            prompting
  --config FILE             Path to the project configuration file
  --help                    Show this message and exit.

Options

--project-path: DIRECTORY

Path to your project root directory (default: current directory)

--force

Overwrite existing great-docs.yml without prompting

--config: FILE

Path to the project configuration file

Examples

  great-docs config                     # Generate docs/great-docs.yml
  great-docs config --force             # Overwrite existing file
  great-docs config --project-path ../pkg