Asciidoc이란
asciidoc은 다음과 같이 정의 된다.
- 노트, 기사, 문서, 서적, 웹페이지, 블로그게시물 등의 페이지를 작성하기 위한 완성된 텍스트 작성 형식(규격)
- HTML,PDF 등을 포함한 다양한 형식으로 AsciiDoc 문서를 번역하기 위한 텍스트 프로세서
AsciiDoc은 경량 마크업 언어에 속한다. 경량 마크업언어의 대표적인 예로 mark down이 존재한다
즉, 간단한 기호와 태그 등으로 문서 편집을 쉽고 빠르고 아름답게(?) 만들도록 도와주는 경량 마크업 언어이다.
AsciiDoc은 메모, 문서, 기사, 서적, 전자책, 슬라이드쇼, 웹 페이지, 매뉴얼 페이지 및 블로그 작성을 위한 텍스트 문서 형식입니다. AsciiDoc 파일은 Asciidoctor 도구 체인을 통해 HTML, PDF, EPUB, DocBook 및 매뉴얼 페이지를 포함한 다양한 형식으로 변환할 수 있습니다. 모든 텍스트 편집기를 사용할 수 있습니다. Github와 같은 일부 웹사이트는 AsciiDoc 파일을 HTML로 직접 렌더링합니다.
- 다음은 John Gruber가 Markdown을 소개한 방법이다.(2004년 3월).
Markdown 서식 구문의 최우선 설계 목표는 가능한 한 읽기 쉽게 만드는 것입니다.
Markdown 형식의 문서는 태그나 형식 지정 지침으로 마크업된 것처럼 보이지 않고 있는 그대로 일반 텍스트로 게시할 수 있어야 합니다.
Markdown 구문에 대한 가장 큰 영감의 원천은 일반 텍스트 이메일 형식입니다.
— Markdown 창시자 John Gruber
- 마찬가지로 Stuart Rackham이 AsciiDoc(2년 전)을 도입하면서 소개한 방법은 다음과 같다.
일반 텍스트 문서를 작성하는 것과 같은 방식으로 AsciiDoc 문서를 작성합니다. 마크업 태그나 이상한 형식 표기가 없습니다. AsciiDoc 파일은 직접 보고, 편집하고, 인쇄하거나 다른 프레젠테이션 형식으로 변환하도록 설계되었습니다.
— AsciiDoc의 창시자 Stuart Rackham
이러한 언어는 사람이 문서를 작성하고 다른 사람이 원시 형식 으로 그대로\ 읽을 수 있도록 설계되었습니다 .
간단한 Asciidoc 파일의 예제
다음 목록은 간단한 Asciidoc 파일의 예입니다.
= The First Asciidoc example: Subtitle // 1
Lars Vogel(c) 2016 vogella GmbH // 2
Version 0.3, 17.05.2021 // 3
:sectnums: // 4
:toc: // 5
:toclevels: 4 // 6
:toc-title: My Content // 7
// 8
:description: Example AsciiDoc document // 9
:keywords: AsciiDoc // 10
:imagesdir: ./img // 11
This is the optional preamble (an untitled section body). Useful for
writing simple sectionless documents consisting only of a preamble.
== First section
Some text
== Second section
More test
- 이것은 자막을 포함한 문서 제목입니다.
- 제목 다음 줄에 저자를 나열할 수 있습니다.
- 이것은 문서의 개정판입니다
- 이 속성은 번호가 매겨진 섹션을 원함을 정의합니다.
- 목차가 생성됩니다
- 기본적으로 목차는 수준 1 및 수준 2 섹션 제목만 표시합니다. toclevels 속성을 사용하면 레벨을 다르게 설정할 수 있습니다.
- 기본적으로 목차는 "목차"라는 제목을 갖게 되며 toc-title 속성을 사용하여 사용자 지정 이름을 설정할 수 있습니다. 이는 html 및 pdf 출력에 적용됩니다
- 버튼 및 메뉴 경로와 같은 실험적 기능 사용
- HTML 출력에 설명 추가
- HTML 출력에 키워드를 추가합니다.
- 기본 이미지 위치를 정의합니다 Asciidoc 문서는 일반적으로 .adoc 로 끝납니다.
AsciiDoc 문법
'기타' 카테고리의 다른 글
마크다운 이미지 나란히, 이미지 정렬 하는법 (0) | 2023.04.26 |
---|---|
커서 기반 페이지네이션(Cursor-based-pagination) vs 오프셋 기반 페이지 네이션(offset-based-pagination (0) | 2022.12.14 |
Asciidoctor란 (0) | 2022.12.12 |
VsCode(Visual Studio Code) 키 십힘, Vim모드, VsCode INSERT 해결방법 (0) | 2022.10.01 |
[Springdocs ]Swagger Error - Failed to fetch. (0) | 2022.09.07 |