マークダウンファイルのローカルでの読み方

[syunsuke]

webファイルをjekyllのマークダウンファイルにしようと思うが、ローカルでファイル編集した場合、どのような体裁になるのかを見れる環境をどう準備すればよいか調べる事

[syunsuke]

GitHub Pagesの説明がGitHub Helpにある

• GitHub Pages Basics
• Customizing GitHub Pages
  • Setting up your GitHub Pages site locally with Jekyll

但し、今のところwindows上でローカルリポジトリからサイトをプレビューするためにjekyll serveをするとエラーになる。

macでは、できる事を確認。

更に、"No GitHub API authentication" error については

• "No GitHub API authentication" error #399
• Resolve “No Github API authentication” errors
• Jekyll with GitHub Pages - Fix the "GitHub Metadata No GitHub API authentication could be found" Error

これらは、windowsの場合には解決できない。
windowsでも、API認証はGit Bash上で環境変数を使ってトークンを渡すとそのエラーは消えるものの、省略されている変数の値が取れていない様子

git bash 上で　環境変数を指定せずにコマンド実行

$ bundle exec jekyll serve
Configuration file: C:/Users/shunsk/Documents/GitHub/syunsuke.github.io/_config.yml
            Source: C:/Users/shunsk/Documents/GitHub/syunsuke.github.io
       Destination: C:/Users/shunsk/Documents/GitHub/syunsuke.github.io/_site
 Incremental build: disabled. Enable with --incremental
      Generating...
   GitHub Metadata: No GitHub API authentication could be found. Some fields may be missing or have incorrect data.
   GitHub Metadata: Error processing value 'description':
  Liquid Exception: No repo name found. Specify using PAGES_REPO_NWO environment variables, 'repository' in your configuration, or set up an 'origin' git remote pointing to your github.com repository. in /_layouts/default.html
             ERROR: YOUR SITE COULD NOT BE BUILT:
                    ------------------------------------
                    No repo name found. Specify using PAGES_REPO_NWO environment variables, 'repository' in your configuration, or set up an 'origin' git remote pointing to your github.com repository.

git bash 上で　環境変数を指定してコマンド実行

$ JEKYLL_GITHUB_TOKEN=xxxxxxxxxxxxxxxxx bundle exec jekyll serve
Configuration file: C:/Users/shunsk/Documents/GitHub/syunsuke.github.io/_config.yml
            Source: C:/Users/shunsk/Documents/GitHub/syunsuke.github.io
       Destination: C:/Users/shunsk/Documents/GitHub/syunsuke.github.io/_site
 Incremental build: disabled. Enable with --incremental
      Generating...
   GitHub Metadata: Error processing value 'description':
  Liquid Exception: No repo name found. Specify using PAGES_REPO_NWO environment variables, 'repository' in your configuration, or set up an 'origin' git remote pointing to your github.com repository. in /_layouts/default.html
             ERROR: YOUR SITE COULD NOT BE BUILT:
                    ------------------------------------
                    No repo name found. Specify using PAGES_REPO_NWO environment variables, 'repository' in your configuration, or set up an 'origin' git remote pointing to your github.com repository.

_config.ymlの中身

theme: jekyll-theme-cayman
gethub: [metadata]
title: "hogehoge"

titleは、エラーの挙動を調べるためにいれたもの。

titleを入れないと、titleでエラーになる

入れると、descriptionでエラーになる（多分、次の省略された変数）

結論として、GitHub Pagesをローカルで管理する場合 面倒なので windowsは使わない