Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

mdbook 用の markdown ファイルを格納するディレクトリの名前を booksrc に変える #952

Merged
merged 1 commit into from
Oct 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
* 地の文はですます調とし、コード例の中の文章は常体とします。
* 読点には `、` を、句点には `。` を使用します。ただし例外として、直前の文字が半角文字であるときには `、` の代わりに半角カンマ `,` を使用します。
* 見出し語 `foo` に対して、目次の中での記事の名前は `foo: (日本語による一言説明)` とします。可能な限り1行に収まるようにしてください。
* 目次である `src/SUMMARY.md` の内の記事は、カテゴリごとにアルファベット昇順に並べてください。VSCode だと [Tyriar.sort-lines](https://marketplace.visualstudio.com/items?itemName=Tyriar.sort-lines) という拡張機能があって、並び替えを自動で行うことができます。
* 目次である `booksrc/SUMMARY.md` の内の記事は、カテゴリごとにアルファベット昇順に並べてください。VSCode だと [Tyriar.sort-lines](https://marketplace.visualstudio.com/items?itemName=Tyriar.sort-lines) という拡張機能があって、並び替えを自動で行うことができます。
* Lean コードは、コンパイルが通るようにして `Examples` 配下に配置します。
* 「エラーになる例」を紹介したいときであっても `try` や `#guard_msgs` や `fail_if_success` などを使ってコンパイルが通るようにしてください。コード例が正しいかチェックする際にその方が楽だからです。
* Lean ファイルのファイル名は、パスカルケースで命名して下さい。
Expand Down
12 changes: 6 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ book

Draft/

/src/*
!src/image
!src/links.md
!src/README.md
!src/404.md
!src/SUMMARY.md
/booksrc/*
!booksrc/image
!booksrc/links.md
!booksrc/README.md
!booksrc/404.md
!booksrc/SUMMARY.md

*.olean
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# README

[![repo logo](./src/image/project_image.png)]()
[![repo logo](./booksrc/image/project_image.png)]()

[![workflow](https://github.com/lean-ja/lean-by-example/actions/workflows/ci.yml/badge.svg)](https://github.com/lean-ja/lean-by-example/blob/main/.github/workflows/ci.yml) [![workflow](https://github.com/lean-ja/lean-by-example/actions/workflows/deploy.yml/badge.svg)](https://github.com/lean-ja/lean-by-example/blob/main/.github/workflows/deploy.yml) [![workflow](https://github.com/lean-ja/lean-by-example/actions/workflows/update.yml/badge.svg)](https://github.com/lean-ja/lean-by-example/blob/main/.github/workflows/update.yml) [![workflow](https://github.com/lean-ja/lean-by-example/actions/workflows/devcontainer.yml/badge.svg)](https://github.com/lean-ja/lean-by-example/blob/main/.github/workflows/devcontainer.yml) [![discord](https://dcbadge.limes.pink/api/server/p32ZfnVawh?style=flat)](https://discord.gg/p32ZfnVawh)

Expand Down Expand Up @@ -45,6 +45,6 @@ If you use this book for your work, please cite it as follows:

このプロジェクトは [Proxima Technology](https://proxima-ai-tech.com/) 様よりご支援を頂いています。

![logo of Proxima Technology](./src/image/proxima.svg)
![logo of Proxima Technology](./booksrc/image/proxima.svg)

Proxima Technology(プロキシマテクノロジー)は数学の社会実装を目指し、その⼀環としてモデル予測制御の民主化を掲げているAIスタートアップ企業です。数理科学の力で社会を変えることを企業の使命としています。
4 changes: 2 additions & 2 deletions assets/filePlay.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ function filePlay() {
// 拡張子が `.md` になっているので `.lean` に修正する
editButtonLink.href = editButtonLink.href.replace(/\.md$/, ".lean");

// Lean ファイルがあるのは `src` ではなく `Examples` ディレクトリ
editButtonLink.href = editButtonLink.href.replace("/src/", "/Examples/");
// Lean ファイルがあるのは `booksrc` ではなく `Examples` ディレクトリ
editButtonLink.href = editButtonLink.href.replace("/booksrc/", "/Examples/");

// 演習問題のファイルのみ、`Examples` ディレクトリではなくて `Exercise` ディレクトリにある
editButtonLink.href = editButtonLink.href.replace(
Expand Down
2 changes: 1 addition & 1 deletion book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
authors = ["Seasawher"]
language = "ja"
multilingual = false
src = "src"
src = "booksrc" # 単に src とすると検索ノイズが多くなることを考慮
title = "Lean by Example"
description = "プログラミング言語であるとともに定理証明支援系でもある Lean 言語と、その主要なライブラリの使い方を豊富なコード例とともに解説した資料です。"

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes.
4 changes: 2 additions & 2 deletions lakefile.lean
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ script build do
runCmd "lake exe mk_exercise Examples/Solution Exercise"

with_time running "mdgen"
runCmd "lake exe mdgen Examples src";
runCmd "lake exe mdgen Exercise src/Exercise"
runCmd "lake exe mdgen Examples booksrc";
runCmd "lake exe mdgen Exercise booksrc/Exercise"

with_time running "mdbook"
runCmd "mdbook build"
Expand Down
4 changes: 2 additions & 2 deletions scripts/Build.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ lake を介することなく実行ファイルを直接叩く。 #>

./.lake/packages/mk-exercise/.lake/build/bin/mk_exercise.exe Examples/Solution Exercise

./.lake/packages/mdgen/.lake/build/bin/mdgen.exe Exercise src/Exercise
./.lake/packages/mdgen/.lake/build/bin/mdgen.exe Examples src
./.lake/packages/mdgen/.lake/build/bin/mdgen.exe Exercise booksrc/Exercise
./.lake/packages/mdgen/.lake/build/bin/mdgen.exe Examples booksrc

mdbook build
Loading