NuGet 패키지에 추가 정보 파일을 포함 하여 패키지 세부 정보를 사용자에게 더 풍부하고 더 유익하게 만들 수 있습니다.
이는 사용자가 NuGet.org 패키지 세부 정보 페이지를 볼 때 표시되는 첫 번째 요소 중 하나일 가능성이 높으며 좋은 인상을 남기는 데 필수적입니다.
중요합니다
NuGet.org Markdown 의 추가 정보 파일 및 제한된 도메인 집합의 이미지만 지원합니다. NuGet.org에서 readme가 올바르게 렌더링되도록 하기 위해, 당사의 이미지를 위한 허용된 도메인 및 지원되는 Markdown 기능을 참조하십시오.
내 리드미 파일에는 어떤 내용이 있어야 하나요?
귀하의 README 파일에 다음 항목을 포함하는 것이 좋습니다.
- 패키지의 정의와 작동 원리에 대한 소개 - 어떤 문제가 해결됩니까?
- 패키지를 시작하는 방법 - 특정 요구 사항이 있나요?
- 추가 정보 자체에 포함되지 않은 경우 보다 포괄적인 설명서에 대한 링크입니다.
- 적어도 몇 가지 코드 조각/샘플 또는 예제 이미지.
- 프로젝트 문제, Twitter, 버그 추적기 또는 기타 플랫폼에 대한 링크와 같은 피드백을 남기는 위치 및 방법입니다.
- 해당하는 경우 기여하는 방법.
예를 들어 이 패키지 추가 정보 템플릿으로 시작할 수 있습니다.
# Package readme title, e.g., display name or title of the package (optional)
Start with a clear and concise description: A brief overview of what your package is and does, also what problem it solves.
## Getting started
Explain how to use your package, provide clear and concise getting started instructions, including any necessary steps.
### Prerequisites
What are specific minimum requirements to use your packages? Consider excluding this section if your package works without any additional setup beyond simple package installation.
## Usage
Examples about how to use your package by providing code snippets/example images, or samples links on GitHub if applicable.
- Provide sample code using code snippets
- Include screenshots, diagrams, or other visual help users better understand how to use your package
## Additional documentation
Provide links to more resources: List links such as detailed documentation, tutorial videos, blog posts, or any other relevant documentation to help users get the most out of your package.
## Feedback
Where and how users can leave feedback?
- Links to a GitHub repository where could open issues, Twitter, a Discord channel, bug tracker, or other platforms where a package consumer can connect with the package author.
고품질의 README 파일은 다양한 형식, 모양 및 크기로 제공될 수 있음을 염두에 두세요. NuGet.org 사용할 수 있는 패키지가 이미 있는 경우 리포지토리에 이미 readme.md NuGet.org 세부 정보 페이지에 추가될 수 있는 기타 설명서 파일이 있을 수 있습니다.
비고
고품질의 README 작성 모범 사례에 대한 블로그를 읽어 보세요.
README 파일 미리 보기
NuGet.org 라이브가 되기 전에 추가 정보 파일을 미리 보려면 NuGet.org 패키지 업로드 웹 포털을 사용하여 패키지를 업로드 하고 메타데이터 미리 보기의 "추가 정보 파일" 섹션까지 아래로 스크롤합니다. 다음과 같이 표시됩니다.
이미지 준수 및 지원되는 서식 지정을 위해 추가 정보 파일을 검토하고 미리 보는 것이 좋습니다. 잠재적 사용자에게 좋은 첫인상을 줄 수 있습니다. NuGet.org에 게시된 패키지의 설명서에서 실수를 수정하려면, 수정된 내용을 포함한 업데이트된 버전을 푸시해야 합니다. 미리 모든 것을 잘 준비해 두면 앞으로의 두통을 피할 수 있습니다.
이미지 및 배지에 허용되는 도메인
보안 및 개인 정보 보호 문제로 인해 NuGet.org 이미지와 배지를 신뢰할 수 있는 호스트에 렌더링할 수 있는 도메인을 제한합니다.
NuGet.org 다음 신뢰할 수 있는 도메인의 배지를 포함한 모든 이미지를 렌더링할 수 있습니다.
- api.codacy.com
- app.codacy.com
- api.codeclimate.com
- api.dependabot.com
- api.travis-ci.com
- api.reuse.software
- app.fossa.com
- app.fossa.io
- avatars.githubusercontent.com
- badge.fury.io
- badgen.net
- badges.gitter.im
- buildstats.info
- caniuse.bitsofco.de
- camo.githubusercontent.com
- cdn.jsdelivr.net
- cdn.syncfusion.com
- ci.appveyor.com
- circleci.com
- codecov.io
- codefactor.io
- coveralls.io
- dev.azure.com
- flat.badgen.net
- github.com/.../workflows/.../badge.svg
- gitlab.com
- img.shields.io
- i.imgur.com
- isitmaintained.com
- opencollective.com
- raw.github.com
- raw.githubusercontent.com
- snyk.io
- sonarcloud.io
- travis-ci.com
- travis-ci.org
- wakatime.com
- user-images.githubusercontent.com
허용 목록에 다른 도메인을 추가해야 한다고 생각되는 경우 문제를 자유롭게 제출 하세요. 개인 정보 보호 및 보안 규정 준수에 대해 엔지니어링 팀에서 검토합니다. 지원되지 않는 도메인에서 호스트되는 상대 로컬 경로 및 이미지가 있는 이미지는 렌더링되지 않으며 패키지 소유자에게만 표시되는 추가 정보 파일 미리 보기 및 패키지 세부 정보 페이지에 경고가 생성됩니다.
지원되는 Markdown 기능
Markdown은 일반 텍스트 서식 구문을 사용하는 경량 생성 언어입니다. NuGet.org 리드미는 Markdig 구문 분석 엔진을 통해 CommonMark 호환 Markdown을 지원합니다.
NuGet.org 현재 다음과 같은 Markdown 기능을 지원합니다.
또한 구문 강조 표시를 지원합니다. 언어 식별자를 추가하여 코드 범위에서 구문 강조 표시를 사용하도록 설정할 수 있습니다.