Closed11

初めての Slate メモ

しんせいたろうしんせいたろう
  1. image を得る方法は2つあって、どちらかをすればよい
  • docker build . -t slatedocs/slate
  • docker pull slatedocs/slate
  • ただし、私の環境では docker build で、以下のようなエラーが発生したので、docker pull でやった
$ docker build . -t slatedocs/slate
...
ERROR: failed to solve: process "/bin/sh -c apt-get update     && apt-get install -y --no-install-recommends         build-essential         git         nodejs     && gem install bundler     && bundle install     && apt-get remove -y build-essential git     && apt-get autoremove -y     && rm -rf /var/lib/apt/lists/*" did not complete successfully: exit code: 1

イメージを確認したいなら

docker image ls
しんせいたろうしんせいたろう
  1. build
docker run --rm --name slate -v $(pwd)/build:/srv/slate/build -v $(pwd)/source:/srv/slate/source slatedocs/slate build

build はうまく行ったけど、ワーニングがでた

Your RubyGems version (3.0.3.1) has a bug that prevents `required_ruby_version` from working for Bundler. Any scripts that use `gem install bundler` will break as soon as Bundler drops support for your Ruby version. Please upgrade RubyGems to avoid future breakage and silence this warning by running `gem update --system 3.2.3`

とりあえず無視

  • この build が終わると、ディレクトリ配下に build ディレクトリが作成される
  • これが静的サイトをサーブするディレクトリ
しんせいたろうしんせいたろう
  1. Slateを実行
docker run --rm --name slate -p 4567:4567 -v $(pwd)/source:/srv/slate/source slatedocs/slate serve

(略)

== View your site at "http://localhost:4567", "http://127.0.0.1:4567"
== Inspect your site configuration at "http://localhost:4567/__middleman", "http://127.0.0.1:4567/__middleman"
  1. 確認
    http://localhost:4567

  2. ドキュメントをちょっと修正
    source/index.html.md にちょっと何か書いて反映されるか確認

しんせいたろうしんせいたろう

Github pages に publish

  1. git remote show origin して、自分自身のアカウントをフォークして作業していることをちゃんと確認する
$ git remote show origin
* remote origin
  Fetch URL: git@github.com:shinseitaro/slate.git
  Push  URL: git@github.com:shinseitaro/slate.git
(略)
  1. さっきの修正を commit and push
git add source/index.html.md 
git commit -m"update index.md"
git put

push するのは markdown ファイルが入っている source 配下だけ

  1. deply
❯ ./deploy.sh --push-only
1ae49fb0908077d2585a2b4f3a71765bebfa4525	refs/heads/gh-pages
remote: Enumerating objects: 5, done.
remote: Counting objects: 100% (5/5), done.
remote: Compressing objects: 100% (1/1), done.
remote: Total 3 (delta 2), reused 3 (delta 2), pack-reused 0
Unpacking objects: 100% (3/3), 324 bytes | 324.00 KiB/s, done.
From github.com:shinseitaro/slate
 * [new branch]      gh-pages   -> gh-pages
   86c5f55..1ae49fb  gh-pages   -> origin/gh-pages
[gh-pages 15bd3f1] publish: update index.md
 2 files changed, 2 deletions(-)
 delete mode 100644 .nojekyll

  1. https://shinseitaro.github.io/slate
    not found
  2. github > settings > pages >
  • Build and deployment > Branch
    • Select branch : gh-pages
    • /(root)
  1. もう一回確認:https://shinseitaro.github.io/slate
  • 初回は10分くらいかかることもある
しんせいたろうしんせいたろう

headers

# Header 1
## Header 2
### Header 3

Header 1と2がTable of Contensとして使用される

パラグラフ

ノーマルテキストはパラグラフとして扱われる。空白の改行を入れると、1パラグラフとして扱われる

しんせいたろうしんせいたろう

ファイル分割

source/includes ディレクトリに、_ファイル名.md でファイルを作り、マークダウンで記述

source/index.html.md のメタデータ内の includes: のところにリスト形式で、_無しファイル名を追加すると、その順にindex.html.mdのあとに追加される

このスクラップは2024/02/19にクローズされました