docfx C# (개발자를 위한 작동 방식)

DocFX 사용 방법

1. .NET SDK 6.0+ 설치
2. PowerShell을 엽니다.
3. DocFX 라이브러리를 설치하기 위해 스크립트를 하나씩 실행합니다.
4. 설치 후 JSON 파일을 실행합니다.
5. 이것은 포트 8080에서 문서 사이트를 엽니다.

DocFX 소개

Microsoft가 개발한 오픈 소스 정적 사이트 생성기 및 문서 생성 도구 DocFX입니다. Markdown 파일과 소스 코드를 사용하여 개발자는 전문가처럼 보이는 문서 웹사이트를 생성할 수 있습니다. DocFX는 다양한 마크업 형식과 프로그래밍 언어를 지원하기 때문에 여러 프로젝트에 걸쳐 널리 적용할 수 있는 적응성이 높은 도구입니다.

개발자는 DocFX를 사용하여 문서에 튜토리얼, 개념적 기사 및 API 참조를 생성할 수 있습니다. 그 적응성 있는 아키텍처로 인해 팀은 자신들의 고유한 요구에 맞게 커스터마이즈하고 확장할 수 있습니다. DocFX는 HTML 및 Markdown을 포함한 여러 출력 형식을 지원하는 교차 참조, 편집 가능한 템플릿 등과 같은 기능도 제공합니다. DocFX의 내부 작동과 방법에 대해 더 자세한 설명이 필요하시면 DocFX Documentation을 방문해 주세요.

DocFX 시작하기

새로운 DocFX 웹사이트 만들기

이번 단계에서는 로컬 컴퓨터에 기본적인 문서 웹사이트를 만들 것입니다.

• 명령줄 작업에 대한 기본적인 이해가 필요합니다. *.NET SDK 6.0 이상의 버전이 필요합니다.

DocFX의 최신 버전을 설치하려면 .NET SDK가 설치되어 있어야 하며, 그런 후 터미널 명령줄 도구를 열고 다음 명령을 입력하세요:

dotnet tool update -g docfx

새로운 문서셋을 시작하려면 실행하세요:

docfx init

docfx init

모든 구성의 JSON 파일을 생성합니다. 이 명령을 사용하여 현재 작업 중인 디렉토리에 새 DocFX 프로젝트를 생성할 수 있습니다. 문서셋을 만들려면 실행하세요:

docfx docfx.json --serve

docfx docfx.json --serve

웹페이지는 이제 http://localhost:8080에서 미리 볼 수 있습니다.

변경 사항을 저장합니다. DocFX는 JSON Configuration 파일을 사용하여 구성됩니다. 이제 새로운 터미널을 사용하여 이 명령을 실행해 웹사이트를 재구축하고 로컬 변경 사항을 미리보려는 중입니다:

docfx docfx.json

docfx docfx.json

DocFX의 기능

DocFX와 IronPDF 통합

DocFX와 IronPDF를 결합하여 개발자는 각 도구의 장점을 활용하고 문서화 프로세스를 개선할 수 있습니다. DocFX로 생성된 HTML 문서를 PDF 형식으로 변환하여 IronPDF를 사용하면 장치 간 일관된 렌더링을 보장하고 오프라인 준비 문서를 생성하며 공유 및 배포를 용이하게 할 수 있습니다. IronPDF에 대한 자세한 내용은 IronPDF 문서를 참조하십시오.

IronPDF 설치

• Visual Studio 프로젝트를 시작하십시오.
• "도구" > "NuGet 패키지 관리자" > "패키지 관리자 콘솔"을 선택하십시오.
• Visual Studio 패키지 관리자 콘솔에서 다음 명령을 입력하십시오(이줄을 적절한 Install-Package 명령으로 수정하세요):

Install-Package IronPdf

• 또는 솔루션용 NuGet 패키지 관리자를 사용하여 IronPDF를 설치할 수 있습니다.

• 검색 결과에서 IronPDF 패키지를 선택한 후 "설치" 옵션을 클릭할 수 있습니다. Visual Studio가 대신하여 다운로드 및 설치를 처리합니다.

  

• NuGet은 프로젝트에 필요한 모든 종속성과 함께 IronPDF 패키지를 설치합니다.
• 설치 후 프로젝트에서 IronPDF를 사용할 수 있습니다.

논리 구현

통합 과정에는 다음 논리가 포함됩니다:

1. DocFX로 문서 만들기: 시작하려면 DocFX를 사용하여 문서를 만드십시오. 프로젝트의 소스 코드 및 Markdown 파일에 대해 DocFX 빌드 프로세스를 실행하여 HTML 문서를 생성합니다.
2. IronPDF를 사용하여 HTML 문서를 PDF로 변환: HTML 문서가 생성된 후 IronPDF를 사용하여 프로그래밍 방식으로 PDF 형식으로 변환하십시오. IronPDF의 HTML에서 PDF로의 변환 기능을 사용하면 HTML 텍스트를 인쇄 가능한 PDF 문서로 쉽게 변환할 수 있습니다.
3. 변환 프로세스를 자동화: 워크플로우 최적화를 위해 C# 코드 또는 스크립트를 사용하여 변환 프로세스를 자동화하십시오. 이것은 수동 개입이 필요하지 않은 경우 문서가 쉽게 업데이트되고 재생성될 수 있도록 보장합니다.

using IronPdf;

class Program
{
    static void Main()
    {
        // Create a new HtmlToPdf Renderer
        var Renderer = new HtmlToPdf();

        // Render the webpage as PDF
        var PDF = Renderer.RenderUrlAsPdf("http://localhost:8080/index.html");

        // Save PDF to a file
        PDF.SaveAs("output.pdf");

        // Inform the user of successful PDF creation
        Console.WriteLine("PDF generated successfully!");
        Console.ReadKey();
    }
}

using IronPdf;

class Program
{
    static void Main()
    {
        // Create a new HtmlToPdf Renderer
        var Renderer = new HtmlToPdf();

        // Render the webpage as PDF
        var PDF = Renderer.RenderUrlAsPdf("http://localhost:8080/index.html");

        // Save PDF to a file
        PDF.SaveAs("output.pdf");

        // Inform the user of successful PDF creation
        Console.WriteLine("PDF generated successfully!");
        Console.ReadKey();
    }
}

Imports IronPdf

Friend Class Program
	Shared Sub Main()
		' Create a new HtmlToPdf Renderer
		Dim Renderer = New HtmlToPdf()

		' Render the webpage as PDF
		Dim PDF = Renderer.RenderUrlAsPdf("http://localhost:8080/index.html")

		' Save PDF to a file
		PDF.SaveAs("output.pdf")

		' Inform the user of successful PDF creation
		Console.WriteLine("PDF generated successfully!")
		Console.ReadKey()
	End Sub
End Class

코드 예제에 대한 자세한 내용은 이 예제 사용 가이드를 참조하십시오. 실행 출력은 아래에 표시됩니다:

결론

마지막으로 DocFX와 IronPDF를 C#에서 통합함으로써 개발자는 PDF 형식의 훌륭한 문서를 생성하고 배포할 수 있는 강력한 선택 옵션을 가집니다. 개발자는 문서 생성에 대한 DocFX 및 IronPDF의 PDF 생성 기능을 결합하여 쉽게 액세스 및 공유할 수 있는 포괄적이고 오프라인 준비된 문서를 생성할 수 있습니다. 이 통합은 문서화 워크플로우를 향상시키고 프로젝트 문서의 가독성과 접근성을 향상시키며 소프트웨어 프로젝트의 성공 가능성을 높입니다.

개발자는 이 문서의 권장 사항을 구현하고 DocFX 및 IronPDF의 기능을 활용함으로써 문서화 절차를 최적화하고 팀워크 및 커뮤니케이션을 개선하며 사용자 및 이해관계자에게 더 나은 문서화 경험을 제공할 수 있습니다.

$799 Lite 번들에는 영구 라이선스, 1년 소프트웨어 유지보수, 라이브러리 업그레이드가 포함됩니다. IronPDF는 재배포 및 시간 제한이 있는 무료 라이선스를 제공합니다. 사용자는 체험 기간 동안 워터마크를 보지 않고 솔루션을 평가할 수 있습니다. 가격 및 라이선스에 대한 추가 정보는 IronPDF의 라이선스 세부 정보를 참조하십시오.