[git] 문서를 Github 페이지와 동기화하려면 어떻게해야합니까?

GitHub Pages가 이미 자동 페이지 생성기를 사용하고있는 Jekyll을 사용한다는 사실을 활용하여 설정 한 솔루션을 게시 할 것입니다.

1. git checkout gh-pages
2. mkdir _layouts
3. mv index.html _layouts
4. git checkout master -- README.md
5. mv README.md index.md
6. 다음 텍스트를 앞에 추가하십시오. index.md

 

---
layout: index
---

또한 index.html파일 을 열고 다음과 같이 변경해야합니다.

1. README.md파일 의 마크 다운에서 렌더링 된 HTML을 제거 합니다. 일반적으로 <section>또는 <article>태그 사이에 있습니다. 이 HTML을 텍스트 {{ content }}로 바꾸면이 파일을 지킬로 사용할 수 있습니다. 레이아웃을 적용 할 파일은 콘텐츠 태그가있는 위치에 배치됩니다.

2. 프로젝트 페이지 테마에 대한 CSS를 찾으십시오. 나를 위해 이것은 다음과 같은 줄이었습니다.

   
<link rel='stylesheet' href='stylesheets/stylesheet.css' />


   다음으로 변경해야합니다.

   
<link rel='stylesheet' href='{{ site.path }}/stylesheets/stylesheet.css' />


3. 이 레이아웃에 사용될 사이트에 저장된 다른 자산도 접두사로 지정해야합니다 {{ site.path }}.

이렇게하면 Jekyll은 마크 다운 파일을 디렉토리 의 index.html레이아웃 내용으로 렌더링합니다 _layouts. README.md 파일뿐만 아니라 마스터 브랜치에있는 다른 문서에 대해서도이 프로세스를 자동화하기 위해 다음 단계를 수행했습니다.

post-commit다음을 포함하는 라는 파일을 생성했습니다 .

 

#!/bin/bash
###
### The following block runs after commit to "master" branch
###
if [ `git rev-parse --abbrev-ref HEAD` == "master" ]; then

    # Layout prefix is prepended to each markdown file synced
    ###################################################################
    LAYOUT_PREFIX='---\r\nlayout: index\r\n---\r\n\r\n'

    # Switch to gh-pages branch to sync it with master
    ###################################################################
    git checkout gh-pages

    # Sync the README.md in master to index.md adding jekyll header
    ###################################################################
    git checkout master -- README.md
    echo -e $LAYOUT_PREFIX > index.md
    cat README.md >> index.md
    rm README.md
    git add index.md
    git commit -a -m "Sync README.md in master branch to index.md in gh-pages"

    # Sync the markdown files in the docs/* directory
    ###################################################################
    git checkout master -- docs
    FILES=docs/*
    for file in $FILES
    do
        echo -e $LAYOUT_PREFIX | cat - "$file" > temp && mv temp "$file"
    done

    git add docs
    git commit -a -m "Sync docs from master branch to docs gh-pages directory"

    # Uncomment the following push if you want to auto push to
    # the gh-pages branch whenever you commit to master locally.
    # This is a little extreme. Use with care!
    ###################################################################
    # git push origin gh-pages

    # Finally, switch back to the master branch and exit block
    git checkout master
fi

편집 : 동일한 레이아웃 파일을 사용하도록 README.md파일과 마크 다운 모두에 대해 위의 스크립트를 업데이트했습니다 docs/*. 이전보다 훨씬 나은 설정입니다. 이 스크립트는 .git/hooks/디렉토리에 있습니다. bash는 경로에 있어야합니다.

다음을 사용하여 파일 _config.yml을 만듭니다.

markdown: redcarpet
path: http://username.github.io/reponame

위 스크립트는 GitHub 페이지 사이트에서도 볼 수 있도록 브랜치 의 docs/*디렉토리에있는 마크 다운 파일도 동기화 master합니다. 이러한 문서에 대한 상대 링크 .md는 gh-pages분기 의 앵커에서 확장 을 제거하기 위해 다음 jQuery 함수를 포함하는 경우 작동합니다 . 다음 스크립트를 디렉토리 index.html에 추가 할 수 있습니다 _layouts.

$(document).on('ready', function () {
    $('a').each(function (i, e) {
        var href = e.href;
        if (href.search('.md') > 0)
            $(this).attr('href', href.split('.md')[0]);
    });
});

편집 : 내 저장소에서 위의 코드를 변경했습니다.이 작업을 수행하는 빠르고 더러운 방법 이었지만 내가 의미하는 바를 아는 경우 모든 경우에 제대로 작동하지 않습니다. 예를 들어 마크 다운 파일 company.mdata.md이 처리되지 않습니다. 바르게. 이 문제를 해결하기 위해 href를 더 신중하게 확인하고 발견되면 확장을 제거하는 다음 스크립트로 업데이트했습니다. 또한 스크립트를보다 일반화하여 ext변수 를 변경하여 다른 확장을 제거하는 데 사용할 수 있도록했습니다 . 다음은 코드입니다.

$(function () {
    $('a').each(function () {
        var ext = '.md';
        var href = $(this).attr('href');
        var position = href.length - ext.length;
        if (href.substring(position) === ext)
            $(this).attr('href', href.substring(0, position));
    });
});

이 모든 것이 어떻게 함께 작동하는지보고 싶다면 여기에 프로젝트 페이지 가있는 CoryG89 / docsync에 예제 저장소를 설정했습니다 .