Skip to content

GeneratorConfig

Markdown 생성기의 설정이에요. 생성기 이름, 프로젝트 루트, 레이블, 시그니처 언어를 정의해요.

시그니처

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;
  }; 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

      타입 정의 섹션의 레이블

  • signatureLanguage · string

    코드 시그니처 하이라이팅을 위한 언어 (예: 'typescript', 'tsx')

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