jdown 다운로드 jdown 소스 코드 다운로드

jdown

기타 카테고리

v1.0.0

다운로드

Markdown에서 컨텐츠를 작성하거나 Markdown 파일을 출력하는 NetLifyCMS와 같은 CMS를 사용하는 경우 JDown은 템플릿 내에서 소비 할 준비가 된 빌드 시간에 HTML이 포함 된 JSON으로 컨텐츠를 변환 할 수 있습니다.

설치하다

$ npm install jdown --save-dev

기본 사용

 const jdown = require ( 'jdown' ) ;
jdown ( 'path/to/content' ) . then ( content => console . log ( content ) ) ;

Markdown 컨텐츠 (프로젝트 루트와 관련하여)로 향하는 경로와 함께 Jdown을 호출하면 콘텐츠를 JSON으로 변환합니다.

콘텐츠 구조

Jdown 출력이라는 JSON의 구조는 컨텐츠 폴더 내의 파일이 구성되는 방식에 따라 다릅니다.

? 파일

객체로 바뀌면 파일 객체는 항상 contents 과 fileInfo 속성을 포함합니다 ...

폴더 내의 파일

그런 다음 부모 폴더와 동일한 이름을 가진 상위 객체 내에서 그룹화 된 개별 객체로 전환됩니다 (한 수준 이상 깊은 곳으로 이동하지 마십시오).

? 컬렉션

파일 개체의 배열을 생성하려면 "컬렉션"이라는 폴더를 만들 수 있습니다. 컬렉션 폴더에는 하위 폴더 만 포함해야하며 각각의 각 파일은 하위 폴더의 각 파일이 다양한 객체에 추가됩니다.

파일 내용

Yaml FrontMatter는 전체 파일의 상단에 포함될 수 있으며 개별 속성으로 생성 된 JSON에 추가됩니다.

 ---
title : Example frontmatter
---

Example Markdown Content

API

jdown ([path], [옵션])

길

유형 : string
필수의

위의 지침과 일치하는 폴더 구조가있는 Markdown 파일을 포함하는 폴더로가는 경로. 경로는 프로젝트 루트와 관련이 있어야하므로 컨텐츠가 /Users/username/project/src/content 에 있으면 jdown('src/content') 사용합니다.

옵션

유형 : object

가격 인하

유형 : object

표시 옵션으로 전달할 수있는 옵션 Jdown은 마크 다운의 구문 분석 방법을 제어하는 데 사용할 수있는 모든 마크 옵션을 지원합니다.

자산

유형 : object

자산 구문 분석 옵션. 구문 분석 자산에 Jdown을 사용하는 것은 완전히 선택 사항이지만 다음과 같은 몇 가지 이점이 있습니다.

Markdown 컨텐츠와 함께 자산을 구성하는 능력
Imagemin을 사용한 이미지 파일의 자동 조정
자산의 마지막 수정 시간 (MTime)을 사용하여 파일 이름을 변경하고 기존 자산의 기존 자산을 피하십시오.

모든 정적 자산은 /assets 폴더 내에 배치해야합니다. 자산 폴더는 최상위 컨텐츠 디렉토리 및/또는 하위 디렉토리에 배치 할 수 있습니다. Markdown 컨텐츠 자산 내에서 my-asset.png 는 /assets 폴더 내에 위치한 자산 인 ![](./assets/my-asset.png) 사용하여 참조 할 수 있습니다.

자산 옵션 객체에는 다음 속성이 포함될 수 있습니다.

재산	유형	기본	설명
산출	끈	./공공의	디렉토리 jdown은 처리 된 자산을 출력합니다
길	끈	/	공개적으로 액세스 가능한 PATH jdown은 파일 이름을 출력으로 선출합니다.
PNG	물체	한정되지 않은	imagemin-pngquant로 전달하는 옵션
JPG	물체	한정되지 않은	imagemin-jpegtran으로 전달하는 옵션
SVG	물체	한정되지 않은	Imagemin-SVGO로 전달하는 옵션
gif	물체	한정되지 않은	Imagemin-SVGO로 전달하는 옵션