Skip to content

GeneratorConfig

마크다운 제너레이터의 설정이에요. 제너레이터 이름, 프로젝트 루트, 라벨, 시그니처 언어를 정의해요.

시그니처

typescript
interface GeneratorConfig {
  name: string;
  projectRoot: string;
  labels?: {
    parameters?: string;
    returns?: string;
    throws?: string;
    examples?: string;
    see?: string;
    version?: string;
    deprecated?: string;
    signature?: string;
    typedef?: string;
    properties?: string;
  };
  signatureLanguage?: string;
}

속성

  • nameRequired · string

    제너레이터 이름 (예: 'vitepress', 'nextra')

  • projectRootRequired · string

    프로젝트 루트 디렉토리의 절대 경로

  • labels · object

    문서 섹션의 커스텀 라벨

    • parameters · string

      매개변수 섹션 라벨

    • returns · string

      반환값 섹션 라벨

    • throws · string

      예외 섹션 라벨

    • examples · string

      예시 코드 섹션 라벨

    • see · string

      참고 섹션 라벨

    • version · string

      버전 섹션 라벨

    • deprecated · string

      사용 중단 섹션 라벨

    • signature · string

      시그니처 섹션 라벨

    • typedef · string

      타입 정의 섹션 라벨

    • properties · string

      속성 섹션 라벨

  • signatureLanguage · string

    코드 시그니처 구문 강조에 사용할 언어 (예: 'typescript', 'tsx')

MIT 라이선스에 따라 배포됩니다.