이두근 문서
1.2.0
설명
설치
요구사항
용법
기여
특허
bicep-docs 는 Bicep 템플릿에 대한 문서를 생성하는 명령줄 도구입니다.
브루 탭 크리스토스갈라노/크리스토스갈라노 양조 설치 bicep-docs
github.com/christosgalano/bicep-docs/cmd/bicep-docs@latest를 설치하세요.
릴리스 페이지에서 최신 바이너리를 다운로드하세요.
bicep-docs를 실행하려면 Azure CLI 또는 Bicep CLI를 설치해야 합니다.
| CLI | 최소 필수 버전 |
|---|---|
| 하늘빛 | 2.64.0 |
| 이두근 | 0.29.0 |
bicep-docs는 Bicep 템플릿에 대한 문서를 생성하는 명령줄 도구입니다.
입력 Bicep 파일 또는 디렉터리가 주어지면 파일을 구문 분석하고 Markdown 형식으로 해당 문서를 생성합니다.
이는 Bicep 템플릿에 대한 문서를 자동으로 생성하고 업데이트하는 데 사용할 수 있습니다.
입력이 디렉터리인 경우 각 main.bicep 에 대해 동일한 디렉터리에 README.md 가 생성됩니다. 이는 모든 하위 디렉터리에 대해 반복적으로 발생합니다.
입력이 Bicep 파일인 경우 출력은 파일이어야 합니다. 그렇지 않으면 오류가 반환됩니다.
출력의 기본값은 명령이 실행되는 디렉터리에 상대적인 README.md 입니다.
주의: Markdown 파일이 이미 있으면 덮어쓰게 됩니다.
--include-sections 및 --exclude-sections 인수와 관련하여 사용 가능한 섹션은 description , usage , modules , resources , parameters , udfs , uddts , variables , outputs 입니다.
순서가 지정된 기본 섹션은 description,usage,modules,resources,parameters,udfs,uddts,variables,outputs 입니다. --exclude-sections 의 기본 입력은 '' 입니다. 이는 이전 버전과의 호환성을 보장합니다.
섹션을 포함할 때 섹션의 순서가 존중됩니다.
섹션을 제외하면 결과는 기본 섹션에서 제외된 섹션을 뺀 값이 됩니다(예: --exclude-sections description,usage modules,resources,parameters,udfs,uddts,variables,outputs 순서대로 포함됩니다).
--include-sections 인수가 기본 섹션과 동일하지 않는 한(예: --include-sections description,usage,modules,resources,parameters,udfs,uddts,variables,outputs ) 두 인수를 동시에 제공할 수 없습니다. .
Bicep 파일을 구문 분석하고 Markdown 파일을 생성합니다.
bicep-docs --input main.bicep --output readme.md
Bicep 파일을 구문 분석하고 동일한 디렉터리에 README.md 파일을 생성합니다.
bicep-docs -i main.bicep
디렉터리를 구문 분석하고 자세한 출력이 포함된 각 main.bicep 파일에 대한 README.md 파일을 생성합니다.
bicep-docs -i ./bicep -V
Bicep 파일을 구문 분석하고 사용자 정의 섹션을 제외하고 README.md를 생성합니다.
bicep-docs --input main.bicep --제외 섹션 udfs,uddts
Bicep 파일을 구문 분석하고 해당 순서대로 리소스와 모듈만 포함하는 README.md를 생성합니다.
bicep-docs ---main.bicep 입력 --include-섹션 리소스, 모듈
더 많은 예는 여기에서 찾을 수 있습니다.
설명서의 형식은 다음과 같습니다.
# 모듈 이름 | 파일 이름## 설명...## 사용법...## 모듈의 모듈 테이블## 리소스의 리소스 테이블## 매개 변수의 매개 변수 테이블## UDDT의 사용자 정의 데이터 형식(UDDT) 테이블## 사용자 정의 함수(UDF) 테이블 of UDFS## 변수변수의 테이블## 출력의 출력 테이블
이 도구는 Bicep 프로젝트에 대해 다음 구조를 따르는 경우 매우 유용합니다.
.
├── bicep
│ │
│ ├── modules
│ │ ├── compute
│ │ │ ├── main.bicep
│ │ │ └── README.md
│ │ └── ...
│ │
│ ├── environments
│ │ ├── development
│ │ │ ├── main.bicep
│ │ │ ├── main.bicepparam
│ │ │ └── README.md
│ │ └── ...이 프로젝트에 기여하는 방법에 대한 정보는 여기에서 확인할 수 있습니다.
이 프로젝트는 MIT 라이선스에 따라 라이선스가 부여됩니다.
