BookClub

読書会

読書会のリポジトリです。

いまは fluent pythonの読書をしようとしています。

下記のようなコンテンツを管理しています。

• github page は、docs の下です。
• hugoを使ってmarkdownからhtmlを生成しています。
  • contentsの下が生成する元markdownファイルの置き場所です。
• connpass用の文書置き場は ann の下です。

環境の作り方

hugo

1. hugoのインストールをする。

   • 私の場合は、Debianなので # apt install hugo でインストールした。

2. リポジトリをcloneしてくる この時に、--recursive を忘れていると、別の手当て方法が必要になる。

3. テーマをgit submodule する。

   • see also Hugoのテーマ「Theer」を作成しました – qqhann
   • themeの一個上のディレクトリに移動します。
   • git clone 時に、--recursiveを付け忘れていたら、git submodule update --init --recursive しましょう。

4. hugo server -D でドラフト状態のテキストを手元のブラウザで、http://localhost:1313/BookClub/を見ながら編集しましょう。

   • なお、新しく記事を作るなら、hugo new ファイル名です。

5. 納得行くまで、作業したら、まずはコミットして作業内容を記録しておきましょう。

6. 次は、htmlの生成です。

   • 作成したファイルの上部にある draft: true をfalseに変えて、fileをsaveして、コミットしておきましょう。
   • リポジトリの直下に移動して、hugoコマンドでhtmlを生成します。
   • 生成された、内容物が、github pageの書き出し先に設定している docs/ ディレクトリの内容を確認してcommitしてpushします。

Daily work

• 他のマシンで、作業してpublishしているとconflict起きやすいから、まずは、git pullする習慣があるといいよ。

参考文献

• hugo-primer/exampleSite/content/blog at master · qqhann/hugo-primer

  • ルビ,youtube、数式

• GFM(GitHub Flavored Markdown) · GitBook

  • table
  • syntax highlight
  • automated link
  • 打ち消し線
  • checkbox

• 文章校正/Redpen

  • RedPen のおすすめ設定 - Qiita
  • RedPen 1.10 ドキュメント

GitHub Actions

• actions/checkout: Action for checking out a repo
• peaceiris/actions-gh-pages: GitHub Actions for GitHub Pages 🚀 Deploy static files and publish your site easily. Static-Site-Generators-friendly.