마크 다운에서 노트에 대한 텍스트 상자를 어떻게 만들 수 있습니까?


94

마크 다운으로 문서를 작성하고 있습니다. 나는 훌륭한 pandoc을 사용하여 markdown 소스에서 docx 및 tex 파일을 만들고 있습니다. 나는 프로그래밍 책이 자주하는 방식으로 독자들에게 팁과 노트를위한 텍스트 상자를 갖고 싶습니다. 마크 다운에서이 작업을 수행하는 방법을 알 수 없습니다. 도울 수 있니?


Microsoft는 문서에서 이에 대한 자체 구문을 사용하지만 사용자 환경에서는 작동하지 않을 것입니다. 아래 답변과의 완전성과 비교를 위해 여기에 포함되었습니다. github.com/MicrosoftDocs/PowerShell-Docs/blob/staging/…
brianary

답변:


103

마크 다운 텍스트에 경고 상자 (예 : 메모 또는 경고)를 삽입하기 위해 일반적으로 수행하는 작업 (pandoc을 사용할 때뿐만 아니라 해당 마크 다운이 지원되는 모든 위치)은 두 개의 수평선으로 콘텐츠를 둘러 쌉니다.

---
**NOTE**

It works with almost all markdown flavours (the below blank line matters).

---

이것은 다음과 같습니다.


노트

모든 마크 다운 맛과 함께 작동합니다 (아래 빈 줄이 중요합니다).


좋은 점은 어떤 마크 다운 플레이버가 지원되는지 또는 어떤 확장이 설치 또는 활성화되어 있는지 걱정할 필요가 없다는 것입니다.

편집 : @ filups21이 주석에서 언급했듯이 RMarkdown에서 수평선이 표시되는 것 같습니다 ***. 따라서 앞에서 언급 한 솔루션은 원래 주장 된대로 모든 마크 다운 버전에서 작동하지 않습니다.


4
이것은 유용하지만 RMarkdown / Rstduio / Knitr에서는 작동하지 않습니다
bjw

2
bjw-rmarkdown의 수평선 ***앞에 빈 줄 이옵니다 . 또는 다음 줄로 시작하여 인용문에 메모를 넣을 수 있습니다 >(앞에 빈 줄이 있음).
filups21

88

GitHub에서는 보통 인용구를 삽입합니다.

> **_NOTE:_**  The note content.

된다 ...

참고 : 참고 내용입니다.

물론, 항상 평범한 HTML이 있습니다 ...


@KamilSJaron : 응? 아니에요. 코드 블록에 대해 생각하고 있습니까?
naught101

@ naught101 아, 나는 인용구를 역 인용으로 읽고 있었다. 그러나 삼중 역 따옴표는 실제로 줄 바꿈이 아닙니다.
Kamil S Jaron

4
저는이 범용 솔루션을 선호합니다. 또한 유니 코드 같은 메모를 접두사로 이모티콘 사용하여 즐기 > ℹ️ This is an information거나 > ⚠️ This is a warning.
pierre_loic 20.06.08

1
이것과 테이블 kludge 는 이 질문을 이식 가능하게 해결 하는 유일한 답변입니다. 상단의 대답에 의해 제안 된 하드 규칙 kludge는 상자를 보여 실패하고, 따라서이 문제를 해결하기 위해 실패합니다. 실제로이 답변은 @pierre_loic의 유니 코드 아이콘 모드 와 결합되어 대부분 reStructuredText 노트를 복제 합니다 .
Cecil Curry

16

똑같은 문제에 대해 찾은 가장 간단한 해결책은 하나의 행과 헤더가없는 여러 줄 테이블을 사용하는 것입니다 (첫 번째 열에 이미지가 있고 두 번째 열에 텍스트가 있음).

----------------------- ------------------------------------
![Tip](images/tip.png)\ Table multiline text bla bla bla bla
                        bla bla bla bla bla bla bla ... the
                        blank line below is important 

----------------------------------------------------------------

(PDF의 경우) 작동 할 수있는 또 다른 접근 방식은 Latex 기본 fbox 지시문 을 사용하는 것입니다 .

 \fbox{My text!}

또는 고급 기능 (및 더보기 좋은 상자)을위한 FancyBox 모듈 : http://www.ctan.org/tex-archive/macros/latex/contrib/fancybox .


1
pandoc 템플릿 파일 내에서 pandoc-markdown 노트가 어떻게 보일지 정의 할 수 있는지 알고 있습니까? 예를 들어 ~ / .pandoc / templates / default.latex?
tmaric

11

훈계 확장을 사용하십시오 . 들어 mkdocs , 그것은 구성 할 수 있습니다 mkdocs.yml파일 :

markdown_extensions:
    - admonition

그런 다음 다음과 같이 md 파일에 메모를 삽입합니다.

!!! note

     This is a note.

여기 에서 예를 참조 하십시오 .


8

Etienne의 솔루션과 유사하게 간단한 테이블 형식은 다음과 같습니다.

| | |
|-|-|
|`NOTE` | This is something I want you to notice. It has a lot of text, and I want that text to wrap within a cell to the right of the `NOTE`, instead of under it.|

(더 강조되는) 또 다른 대안은 내용을 본문없는 테이블의 헤더로 만드는 것입니다.

|`NOTE` | This is something I want you to notice. It has a lot of text, and I want that text to wrap within a cell to the right of the `NOTE`, instead of under it.|
|-|-|

마지막으로 가로선 (주제 구분선)을 포함하여 닫힌 상자를 만들 수 있습니다 (선 스타일은 표의 머리글 선과 약간 다릅니다).

| | |
|-|-|
|`NOTE` | This is something I want you to notice. It has a lot of text, and I want that text to wrap within a cell to the right of the `NOTE`, instead of under it.|

---

텍스트 뒤의 빈 줄에 유의하십시오.


이 솔루션을 많이 좋아하지만 pandoc과 xelatex를 통해 pdf로 변환하면 " NOTE"열에 대해 50 %를 할당 하고 다른 열에 대해 50 %를 할당하는 것 같습니다 . stackoverflow.com/questions/27219629에 따라 여러 줄 테이블을 사용할 수 있지만 다른 형식 문제가 있습니다.
sdbbs

7

다음은 간단한 라텍스 기반의 예입니다.

---
header-includes:
    - \usepackage[most]{tcolorbox}
    - \definecolor{light-yellow}{rgb}{1, 0.95, 0.7}
    - \newtcolorbox{myquote}{colback=light-yellow,grow to right by=-10mm,grow to left by=-10mm, boxrule=0pt,boxsep=0pt,breakable}
    - \newcommand{\todo}[1]{\begin{myquote} \textbf{TODO:} \emph{#1} \end{myquote}}
---

blah blah

\todo{something}

blah

결과 : 여기에 이미지 설명 입력

안타깝게도 이것이 라텍스이기 때문에 더 이상 TODO 상자에 마크 다운을 포함 할 수 없으며 (일반적으로 큰 문제는 아닙니다) PDF 이외의 형식 (예 : html)으로 변환 할 때는 작동하지 않습니다.


5

다음 메서드는 GitHub, GitLab ... 및 Stackoverflow 에서 작동하며 이제 CommonMark !


> 인용구로 만든 One-Line Box

인용구로 만든 한 줄 상자


`백틱으로 만든 한 줄 상자`

One-Line Box made with Backticks


```
삼중 백틱으로 만든 상자
```

Box made with Triple Backticks  


~ ~ ~
3 중 물결표로 만든 상자
(물결표 사이의 공백을 제거하여이 작업을 수행)
~ ~ ~

Box made with Triple Tildes


각 줄의 시작 부분에 네 개의 공백이 있는 상자 :

    “Sometimes we must let go of our pride and do what is requested of us.”
    Padmé Amidala


... 또는 수평선을 사용합니까?

세 개의 대시 (---)는 수평선을 만듭니다.


참고 : "초점이 현실을 결정합니다." – 퀴곤 진.


더 많은 구성에 대해서는 우수한 GitLab Markdown Guide를 강력히 권장합니다 .
덜 자세한 GitHub 기본 형식 지정 구문을 확인할 수도 있습니다 . Babelmark를
사용하여 Markdown 구현을 비교할 수 있습니다 .

유용한 힌트 :

  • 줄 바꿈을 강제하려면 줄 끝에 두 개의 공백을 넣으십시오.

  • 특수 문자를 이스케이프하려면 \를 사용하십시오.


3

이중 탭을 사용해 보셨습니까? 상자를 만들려면 :

Start on a fresh line
Hit tab twice, type up the content
Your content should appear in a box

html 출력이있는 일반 Rmarkdown 문서에서 저에게 효과적입니다. 이중 탭 부분은 둥근 직사각형 밝은 회색 상자에 표시되어야합니다.


VS Code 및 GitHub에서도 작동합니다!
Nagev


0

또 다른 해결책은 CSS 인접성을 사용하고 h4 이상을 사용하는 것입니다.

#### note

This is the note content
h4 {
  display: none; /* hide */
}

h4 + p {
  /* style the note however you want */
}
당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.