gitbook 입문 강좌의 흰둥이 다 알아볼 수 있는 Gitbook 플러그인 개발 전 프로세스

플러그인 소개Gitbook 플러그인은 GitBook 기능(전자책과 사이트)을 확장하는 가장 좋은 방식이다.Gitbook에 기본적으로 제공되지 않은 기능이라면 플러그인 메커니즘을 바탕으로 자체적으로 확장할 수 있으며 플러그인은 Gitbook을 더욱 강하게 만든다.
본고는 플러그인에 대한 지식을 전면적으로 소개하고 플러그인 개발의 전체 절차를 중점적으로 소개하고자 한다. 플러그인 개발 절차를 숙지해야만 목표를 세우고 마음속에 자신이 있는 플러그인을 개발할 수 있다.
플러그인에 관해서는 Gitbook 입문 강좌의 고급 진급 시리즈를 참고하시고 본고는 개발Gitbook의 기본 절차를 중점적으로 설명하고자 합니다.

gitbook 입문 강좌의 플러그인 소개

gitbook 입문 강좌의 실용 플러그인

gitbook 입문 강좌의 테마 플러그인

플러그인을 발견하는 방법
당신은 Gitbook 홈페이지에서 플러그인을 쉽게 검색할 수 있고, npmjs 홈페이지에서 gitbook-plugin- 플러그인을 검색할 수 있습니다.
목전Gitbook 공식
더 이상 플러그인 사이트를 유지하기 위해npmjs 검색Gitbook 플러그인.
플러그인 설치 방법
설치하고 싶은 플러그인을 찾으면 book.json 프로필에 추가해야 합니다. 이 파일이 없으면 스스로 만들어야 합니다.

{
    "plugins": ["myPlugin", "anotherPlugin"]
}

다음 명령을 사용하여 특정 버전을 지정할 수도 있습니다.[email protected].기본적으로 버전을 작성하지 않은 경우 GitBook 최신 버전 (호환 버전) 의 플러그인을 사용합니다.
플러그인 설치

홈페이지 온라인 환경이면 사이트에서 자동으로 플러그인을 설치해 줍니다.

로컬 환경이라면 gitbook install를 직접 실행하여 플러그인을 설치합니다.

$ gitbook install

또는 npm 플러그인을 미리 다운로드하여 로컬 프로젝트에 설치합니다.

$ npm install gitbook-plugin-

$ gitbook install

플러그인 구성
플러그인의 설정은 book.json 프로필의 pluginsConfig 속성에 있습니다(이 속성이 없으면 스스로 만드십시오). 플러그인을 설치할 때 플러그인의 문서를 찾아서 관련 옵션에 대한 상세한 정보를 알아보는 것이 좋습니다.

{
    "plugins": ["github"],
    "pluginsConfig": {
        "github": {
          "url": "https://github.com/snowdreams1006/snowdreams1006.github.io"
        }
    }
}

일부 플러그인은 플러그인 설정 항목을 제공하지 않아서 이 절차를 생략할 수 있으며, 어떤 플러그인은 설정 항목을 제공하여 플러그인 소개 문서를 기준으로 한다.
플러그인 개발 방법GitBook 플러그인은 npm에서 발표한 전통적인 정의를 따르는 node 패키지로 표준node규범 외에 Gitbook 자체 정의와 관련된 규범도 있다.
디렉토리 구조Gitbook 플러그인의 가장 기본적인 프로젝트 구조는 적어도 설정 파일package.json과 입구 파일index.js을 포함하고 기타 디렉터리 파일은 플러그인의 용도에 따라 자체적으로 증감한다.

.
├── index.js
└── package.json

실제 플러그인 항목은 약간 다릅니다._layouts 레이아웃 디렉토리,asset 리소스 카탈로그 및 사용자 정의example 샘플 카탈로그 및docs 문서 목록 등등.
package.json package.json는 nodejs의 프로필이고 Gitbook 플러그인도 이 규범을 따른다. 프로필은 플러그인의 버전 묘사 정보를 설명하고 그 외에 Gitbook와 관련된 필드도 있다. schema 준칙에 따라 기본적인 예는 다음과 같다.

{
    "name": "gitbook-plugin-mytest",
    "version": "0.0.1",
    "description": "This is my first GitBook plugin",
    "engines": {
        "gitbook": ">1.x.x"
    },
    "gitbook": {
        "properties": {
            "myConfigKey": {
                "type": "string",
                "default": "it's the default value",
                "description": "It defines my awesome config!"
            }
        }
    }
}

주의해야 할 것은,
패키지 이름은gitbook-plugin- 시작,
패키지 엔진은gitbook .하면, 만약, 만약...package.json의 규범은 공식 문서를 참고할 수 있다.
index.js index.js는 플러그 인이 실행될 때의 엔트리이며 기본 예는 다음과 같습니다.

module.exports = {
    //     
    hooks: {},

    //    
    blocks: {},

    //    
    filters: {}
};

플러그인 게시GitBook 플러그인은 npmjs 홈페이지에 게시할 수 있습니다.
플러그인을 발표하려면 먼저 npmjs 홈페이지에 계정을 등록한 후 명령행을 통해 발표해야 한다.

$ npm publish

전용 플러그인
전용 플러그인은 GitHub에 위탁 관리하고 giturls:

{
    "plugins": [
        "myplugin@git+https://github.com/MyCompany/mygitbookplugin.git#1.0.0"
    ]
}

로컬 테스트 플러그인npm link를 사용하면 발표하기 전에 플러그인을 테스트할 수 있습니다. 명령 상세 정보는 공식 문서를 참고하십시오.
플러그인 폴더에서 다음을 실행합니다.

$ npm link

그런 다음 책이나 문서의 폴더에서 다음을 수행합니다.

$ npm link gitbook-plugin-

유닛 테스트 플러그인gitbook-tester 플러그인을 쉽게 작성할 수 있습니다.js/Mocha 단원 테스트.
사용Travis.제출/탭마다 테스트를 실행할 수 있습니다.
플러그인 요약Gitbook 플러그인은 확장Gitbook 기능의 선택이다. nodejs 프로젝트의 개발 절차에 익숙하면 Gitbook가 제공하는 인터페이스 문서를 조금만 익히면 자신의 플러그인을 개발하는 것은 어렵지 않을 것이다!
본고는 당신이 Gitbook 플러그인을 이해하는 데 도움이 되고 플러그인 개발의 전 과정을 이해하고 숙련할 수 있기를 바랍니다. 만약에 본고가 당신에게 도움이 된다면 저에게 긍정적인 피드백을 해서 제가 계속 창작하도록 격려하는 것을 잊지 마세요!
읽기 확장

플러그 인Gitbook 소개

플러그인 만들기 방법Gitbook

플러그인 테스트 방법Gitbook

만약 본문이 당신에게 도움이 된다면 칭찬할 필요도 없고 전달할 필요도 없다. 직접 칭찬 댓글을 눌러서 격려를 해주면 된다!