당신이 사용할 수있는 pandoc Linux에서 40 개 이상의 파일 형식간에 변환 할 수 있습니다. Markdown을 작성하고 다음 위치에 저장하여 간단한 docs-as-code 시스템을 만드는 데 사용할 수도 있습니다. git, 지원되는 형식으로 게시합니다.
문서 변환 및 Docs-as-Code
다음 중 하나에 문서가있는 경우 pandoc's 지원되는 많은 파일 형식을 다른 파일 형식으로 변환하는 것은 간단합니다. 가지고있는 편리한 도구입니다!
그러나 진정한 힘은 pandoc 간단한 docs-as-code 시스템의 기초로 사용할 때 분명해집니다. docs-as-code의 전제는 소프트웨어 개발의 일부 기술과 원칙을 채택하고 특히 소프트웨어 개발 프로젝트의 경우 문서 작성에 적용하는 것입니다. 그러나 모든 종류의 문서 개발에 적용 할 수 있습니다.
소프트웨어 개발자는 자신이 좋아하는 편집기 또는 IDE (통합 개발 환경)를 사용하여 프로그램을 작성합니다. 입력 한 코드는 텍스트 파일에 저장됩니다. 여기에는 프로그램의 소스 코드가 포함되어 있습니다.
그들은 버전 제어 시스템 또는 VCS (Git가 가장 많이 사용됨)를 사용하여 소스 코드가 개발되고 향상 될 때 변경 사항을 캡처합니다. 이것은 프로그래머가 소스 코드 파일의 모든 버전에 대한 완전한 기록을 가지고 있음을 의미합니다. 이전 버전의 파일에 빠르게 액세스 할 수 있습니다. Git은 파일을 저장소에 저장합니다. 각 개발자의 컴퓨터에는 로컬 저장소가 있고 클라우드에 호스팅되는 중앙 공유 원격 저장소가 있습니다.
프로그램의 작동 버전을 생성 할 준비가되면 컴파일러를 사용하여 소스 코드를 읽고 바이너리 실행 파일을 생성합니다.
가벼운 텍스트 기반 마크 업 언어로 문서를 작성하면 VCS를 사용하여 작성 버전을 제어 할 수 있습니다. 문서를 배포하거나 게시 할 준비가되면 다음을 사용할 수 있습니다. pandoc 웹 기반 (HTML), 워드 프로세서 또는 조판 (LibreOffice, Microsoft Word, TeX), PDF (Portable Document Format), ePub (e-book) 및 곧.
버전이 제어되는 간단한 텍스트 파일 세트에서이 모든 작업을 수행 할 수 있습니다.
pandoc 설치
설치하기 위해서 pandoc Ubuntu에서는 다음 명령을 사용하십시오.
sudo apt-get install pandoc
Fedora에서 필요한 명령은 다음과 같습니다.
sudo dnf install pandoc
Manjaro에서는 다음을 입력해야합니다.
sudo pacman -Syu pandoc
다음을 사용하여 설치 한 버전을 확인할 수 있습니다. --version 선택권:
pandoc --version
파일없이 pandoc 사용
사용하는 경우 pandoc 명령 줄 옵션없이 입력 된 입력도 허용합니다. Ctrl + D를 누르면 입력이 완료되었음을 나타냅니다. pandoc Markdown 형식으로 입력해야하며 HTML 출력을 생성합니다.
예를 살펴 보겠습니다.
pandoc
몇 줄의 Markdown을 입력했으며 Ctrl + D를 누르려고합니다.
그러 자마자 pandoc 동등한 HTML 출력을 생성합니다.
유용한 작업을 수행하려면 pandoc하지만 우리는 정말로 파일을 사용해야합니다.
마크 다운 기초
Markdown은 가벼운 마크 업 언어이며 특정 문자에 특별한 의미가 부여됩니다. 일반 텍스트 편집기를 사용하여 Markdown 파일을 만들 수 있습니다.
마크 다운은 텍스트에서주의를 분산시키는 시각적으로 번거로운 태그가 없기 때문에 쉽게 읽을 수 있습니다. Markdown 문서의 서식은 그것이 나타내는 서식과 유사합니다. 다음은 몇 가지 기본 사항입니다.
- 텍스트를 강조하려면 기울임 꼴, 별표로 묶습니다.
*This will be emphasized* - 에 굵게 텍스트에는 별표 두 개를 사용하십시오.
**This will be in bold** - 제목은 숫자 기호 / 해시 표시 (
#). 텍스트는 공백으로 해시와 구분됩니다. 최상위 제목에는 하나의 해시를 사용하고 두 번째 수준에는 두 개를 사용하는 식입니다. - 글 머리 기호 목록을 만들려면 목록의 각 줄을 별표로 시작하고 텍스트 앞에 공백을 삽입합니다.
- 번호 매기기 목록을 만들려면 각 줄을 숫자와 마침표로 시작하고 텍스트 앞에 공백을 삽입합니다.
- 하이퍼 링크를 만들려면 사이트 이름을 대괄호 (
[]) 및 괄호 안의 URL [()] 이렇게 :[Link to How to Geek](https://www.howtogeek.com/). - 이미지를 삽입하려면 대괄호 () 바로 앞에 느낌표를 입력합니다.
![]). 괄호 안에 이미지의 대체 텍스트를 입력합니다. 그런 다음 이미지 경로를 괄호로 묶습니다. [()“]. 예를 들면 다음과 같습니다..
다음 섹션에서이 모든 것에 대한 더 많은 예를 다룰 것입니다.
관련 : 마크 다운이란 무엇이며 어떻게 사용합니까?
파일 변환
파일 변환은 간단합니다. pandoc 일반적으로 파일 이름에서 작업중인 파일 형식을 확인할 수 있습니다. 여기에서는 Markdown 파일에서 HTML 파일을 생성합니다. 그만큼 -o (출력) 옵션은 pandoc 우리가 만들고자하는 파일의 이름 :
pandoc -o sample.html sample.md
샘플 Markdown 파일 인 sample.md에는 아래 이미지에 표시된 Markdown의 짧은 섹션이 포함되어 있습니다.
sample.html이라는 파일이 생성됩니다. 파일을 두 번 클릭하면 기본 브라우저가 파일을 엽니 다.
이제 LibreOffice Writer에서 열 수있는 Open Document Format 텍스트 문서를 생성 해 보겠습니다.
pandoc -o sample.odt sample.md
ODT 파일에는 HTML 파일과 동일한 내용이 있습니다.
깔끔한 터치는 이미지의 대체 텍스트이며 그림의 캡션을 자동으로 생성하는데도 사용됩니다.
파일 형식 지정
그만큼 -f (에서) 및 -t (to) 옵션은 pandoc 변환하려는 파일 형식. 파일 확장자를 다른 관련 형식과 공유하는 파일 형식으로 작업하는 경우 유용 할 수 있습니다. 예를 들어, TeX와 LaTeX는 모두 “.tex”확장자를 사용합니다.
우리는 또한 -s (독립형) 옵션이므로 pandoc 문서가 완전하고 독립적이며 잘 구성된 LaTeX 문서가되는 데 필요한 모든 LaTeX 프리앰블을 생성합니다. 없이 -s (독립 실행 형) 옵션을 사용하는 경우 출력은 다른 LaTeX 문서에 삽입 될 수있는 올바른 형식의 LaTeX이며 독립 실행 형 LaTeX 문서로 제대로 구문 분석되지 않습니다.
다음을 입력합니다.
pandoc -f markdown -t latex -s -o sample.tex sample.md
텍스트 편집기에서 “sample.tex”파일을 열면 생성 된 LaTeX가 표시됩니다. LaTeX 편집기가있는 경우 TEX 파일을 열어 LaTeX 조판 명령이 어떻게 해석되는지 미리 볼 수 있습니다. 아래 이미지에 맞게 창을 축소하면 디스플레이가 좁아 보이지만 실제로는 괜찮 았습니다.
우리는 Texmaker라는 LaTeX 편집기를 사용했습니다. Ubuntu에 설치하려면 다음을 입력하십시오.
sudo apt-get install texmaker
Fedora에서 명령은 다음과 같습니다.
sudo dnf install texmaker
Manjaro에서 다음을 사용하십시오.
sudo pacman -Syu texmaker
템플릿으로 파일 변환
당신은 아마도 유연성을 이해하기 시작했을 것입니다. pandoc 제공합니다. 한 번 작성하면 거의 모든 형식으로 게시 할 수 있습니다. 대단한 위업이지만 문서는 약간 바닐라 보입니다.
템플릿을 사용하여 스타일을 지정할 수 있습니다. pandoc 문서를 생성 할 때 사용합니다. 예를 들어 다음과 같이 말할 수 있습니다. pandoc CSS (Cascading Style Sheets) 파일에 정의 된 스타일을 --css 선택권.
아래 텍스트를 포함하는 작은 CSS 파일을 만들었습니다. 레벨 헤더의 위와 아래 간격을 한 스타일로 변경합니다. 또한 텍스트 색상을 흰색으로 변경하고 배경 색상을 파란색 음영으로 변경합니다.
h1 {
color: #FFFFFF;
background-color: #3C33FF;
margin-top: 0px;
margin-bottom: 1px;
}
전체 명령은 다음과 같습니다. 독립형 옵션 (-s) :
pandoc -o sample.html -s --css sample.css sample.md
pandoc 미니멀 한 CSS 파일의 단일 스타일을 사용하여 레벨 1 헤더에 적용합니다.
HTML 파일로 작업 할 때 사용할 수있는 또 다른 미세 조정 옵션은 Markdown 파일에 HTML 마크 업을 포함하는 것입니다. 이것은 생성 된 HTML 파일에 표준 HTML 마크 업으로 전달됩니다.
하지만이 기술은 HTML 출력 만 생성하는 경우를 위해 예약되어야합니다. 여러 파일 형식으로 작업하는 경우 pandoc HTML이 아닌 파일에 대한 HTML 마크 업을 무시하고 텍스트로 전달합니다.
ODT 파일이 생성 될 때 사용되는 스타일도 지정할 수 있습니다. 빈 LibreOffice Writer 문서를 열고 필요에 맞게 제목과 글꼴 스타일을 조정합니다. 이 예에서는 머리글과 바닥 글도 추가했습니다. 문서를 “odt-template.odt”로 저장합니다.
이제 이것을 템플릿으로 사용할 수 있습니다. --reference-doc 선택권:
pandoc -o sample.odt --reference-doc=odt-template.odt sample.md
이것을 이전의 ODT 예제와 비교하십시오. 이 문서는 다른 글꼴을 사용하고 색이 지정된 머리글과 머리글과 바닥 글을 포함합니다. 그러나 정확히 동일한 “sample.md”Markdown 파일에서 생성되었습니다.
참조 문서 템플릿을 사용하여 문서 제작의 여러 단계를 표시 할 수 있습니다. 예를 들어 “초안”또는 “검토 용”워터 마크가있는 템플릿이있을 수 있습니다. 워터 마크가없는 템플릿은 완성 된 문서에 사용됩니다.
PDF 생성
기본적으로, pandoc LaTeX PDF 엔진을 사용하여 PDF 파일을 생성합니다. 적절한 LaTeX 종속성이 충족되었는지 확인하는 가장 쉬운 방법은 Texmaker와 같은 LaTeX 편집기를 설치하는 것입니다.
하지만 이것은 상당히 큰 설치입니다. Tex와 LaTeX는 모두 상당히 무겁습니다. 하드 드라이브 공간이 제한되어 있거나 TeX 또는 LaTeX를 사용하지 않을 것임을 알고 있다면 ODT 파일을 생성하는 것이 좋습니다. 그런 다음 LibreOffice Writer에서 파일을 열고 PDF로 저장할 수 있습니다.
문서로서의 코드
Markdown을 작문 언어로 사용하면 다음과 같은 몇 가지 이점이 있습니다.
-
일반 텍스트 파일 작업은 빠릅니다. 비슷한 크기의 워드 프로세서 파일보다로드 속도가 빠르며 문서를 더 빠르게 이동하는 경향이 있습니다. 다음을 포함한 많은 편집자
gedit,Vim, 및Emacs, Markdown 텍스트에 구문 강조 표시를 사용합니다. - 문서의 모든 버전에 대한 타임 라인이 있습니다. 문서를 Git과 같은 VCS에 저장하면 동일한 파일의 두 버전 간의 차이점을 쉽게 확인할 수 있습니다. 그러나 이것은 파일이 일반 텍스트 인 경우에만 실제로 작동합니다. VCS가 작동 할 것으로 예상하는 것입니다.
- VCS는 변경 한 사람과 다음시기를 기록 할 수 있습니다. 이는 대규모 프로젝트에서 다른 사람들과 자주 공동 작업하는 경우 특히 유용합니다. 또한 문서 자체에 대한 중앙 저장소를 제공합니다. GitHub, GitLab 및 BitBucket과 같은 많은 클라우드 호스팅 Git 서비스는 가격 책정 모델에 프리 티어가 있습니다.
- 여러 형식으로 문서를 생성 할 수 있습니다. 몇 개의 간단한 쉘 스크립트만으로 CSS 및 참조 문서에서 스타일을 가져올 수 있습니다. CI / CD (Continuous Integration and Continuous Deployment) 플랫폼과 통합되는 VCS 저장소에 문서를 저장하면 소프트웨어가 빌드 될 때마다 자동으로 생성 될 수 있습니다.
관련 : GitHub의 정의 및 용도
마지막 생각들
pandoc에는 여기서 다룬 것보다 더 많은 옵션과 기능이 있습니다. 대부분의 파일 형식에 대한 변환 프로세스를 조정하고 미세 조정할 수 있습니다. 자세한 내용은 공식 (매우 상세한) pandoc 웹 페이지에서 훌륭한 예제를 확인하십시오.
