-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit f400f51
Showing
6 changed files
with
111 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
venv/ | ||
site/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
{ | ||
"yaml.schemas": { | ||
"https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml" | ||
}, | ||
"yaml.customTags": [ | ||
"!ENV scalar", | ||
"!ENV sequence", | ||
"tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg", | ||
"tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji", | ||
"tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Document | ||
|
||
Sports-day に関わるドキュメントと教育用資料を管理するレポジトリ | ||
|
||
https://document.sports-day.net | ||
|
||
## Material MkDocs 公式リファレンス | ||
|
||
Material MkDocs を使用することで見やすいドキュメントを作成することができます。 | ||
|
||
https://squidfunk.github.io/mkdocs-material/reference/ | ||
|
||
## ローカル環境 | ||
|
||
1. Material MkDocs のインストール | ||
|
||
``` | ||
pip install mkdocs-material | ||
``` | ||
|
||
2. ローカルサーバーの起動 | ||
|
||
``` | ||
mkdocs serve | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Sports-day | ||
|
||
Sports-day に関わるドキュメント |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
window.MathJax = { | ||
tex: { | ||
inlineMath: [["\\(", "\\)"]], | ||
displayMath: [["\\[", "\\]"]], | ||
processEscapes: true, | ||
processEnvironments: true, | ||
}, | ||
options: { | ||
ignoreHtmlClass: ".*|", | ||
processHtmlClass: "arithmatex", | ||
}, | ||
}; | ||
|
||
document$.subscribe(() => { | ||
MathJax.typesetPromise(); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
site_name: Document | ||
copyright: "© 2023-present Sports-day" | ||
repo_url: https://github.com/Sports-day/Document | ||
repo_name: Sports-day/Document | ||
extra: | ||
social: | ||
- icon: fontawesome/brands/github | ||
link: https://github.com/Sports-day | ||
theme: | ||
name: material | ||
language: ja | ||
features: | ||
- navigation.top | ||
- content.code.copy | ||
- content.code.select | ||
- content.code.annotate | ||
- content.tabs.link | ||
extra_javascript: | ||
- js/mathjax.js | ||
- https://polyfill.io/v3/polyfill.min.js?features=es6 | ||
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js | ||
markdown_extensions: | ||
- pymdownx.arithmatex: | ||
generic: true | ||
- admonition | ||
- pymdownx.details | ||
- attr_list | ||
- md_in_html | ||
- pymdownx.highlight: | ||
anchor_linenums: true | ||
line_spans: __span | ||
pygments_lang_class: true | ||
- pymdownx.inlinehilite | ||
- pymdownx.snippets | ||
- pymdownx.tabbed: | ||
alternate_style: true | ||
- tables | ||
- pymdownx.superfences: | ||
custom_fences: | ||
- name: mermaid | ||
class: mermaid | ||
format: !!python/name:pymdownx.superfences.fence_code_format | ||
- pymdownx.critic | ||
- pymdownx.caret | ||
- pymdownx.keys | ||
- pymdownx.mark | ||
- pymdownx.tilde | ||
- pymdownx.emoji: | ||
emoji_index: !!python/name:material.extensions.emoji.twemoji | ||
emoji_generator: !!python/name:material.extensions.emoji.to_svg | ||
- def_list | ||
- pymdownx.tasklist: | ||
custom_checkbox: true |