diff options
author | 安竹洋平 <61961825+yasutakeyohei@users.noreply.github.com> | 2024-05-09 00:18:45 +0900 |
---|---|---|
committer | 安竹洋平 <61961825+yasutakeyohei@users.noreply.github.com> | 2024-05-09 00:18:45 +0900 |
commit | 51657761b2414593fe714074fac481165fb5b346 (patch) | |
tree | ebed34f0d5581d7c7306f97d97748ef61d7d467c /blog/2024/01 | |
parent | b5f689f2357ace65c25492ae64d784460453cec7 (diff) |
textlintに従って修正
Diffstat (limited to 'blog/2024/01')
-rw-r--r-- | blog/2024/01/27/docusaurus-admonition-heading-toc/index.mdx | 26 | ||||
-rw-r--r-- | blog/2024/01/31/sagawa-aiki-kouen-seibi-joukyou/index.mdx | 11 |
2 files changed, 20 insertions, 17 deletions
diff --git a/blog/2024/01/27/docusaurus-admonition-heading-toc/index.mdx b/blog/2024/01/27/docusaurus-admonition-heading-toc/index.mdx index a2d7798b..02e774f4 100644 --- a/blog/2024/01/27/docusaurus-admonition-heading-toc/index.mdx +++ b/blog/2024/01/27/docusaurus-admonition-heading-toc/index.mdx @@ -16,13 +16,13 @@ hide_table_of_contents: false {/* truncate */} -facebookが母体なので色々と気になるところですが、[React](https://ja.legacy.reactjs.org/)を初めとして有益なソフトウェアを完全なオープンソースとして提供してくれていることは純粋にありがたいと感じます。 +Facebookが母体なのでいろいろと気になるところですが、[React](https://ja.legacy.reactjs.org/)を初めとして有益なソフトウェアを完全なオープンソースとして提供してくれていることは純粋にありがたいと感じます。 ## Admonitionのタイトルが見出しにならない -さてDocusaurusには[Admonition](https://docusaurus.io/docs/markdown-features/admonitions)(注意書きや警告文)を容易にmarkdownで書く方法が用意されています。 +さてDocusaurusには[Admonition](https://docusaurus.io/docs/markdown-features/admonitions)(注意書きや警告文)を容易にMarkdownで書く方法が用意されています。 -例えばinfoなら、次のようにmarkdownで書けば、 +たとえばinfoなら、次のようにMarkdownで書けば、 ```mdx title="Admonitionの記法(mdもしくはmdxに記載)" :::info[infoの例] @@ -77,7 +77,7 @@ facebookが母体なので色々と気になるところですが、[React](http ## カスタマイズ後はどうなるか -後述のカスタマイズをすると、Admonitionのタイトル部に(通常の見出しmarkdownと同様に)**#を冒頭に2個以上入れる** ことで見出しになります。またTOCにも反映されます。#を2個以上としているのは、H1をAdmonitionには使わないはずのため。また#を入れない場合は見出しにならず、TOCにも反映されません。 +後述のカスタマイズをすると、Admonitionのタイトル部に(通常の見出しMarkdownと同様に)**#を冒頭に2個以上入れる** ことで見出しになります。またTOCにも反映されます。#を2個以上としているのは、H1をAdmonitionには使わないはずのため。#を入れない場合は見出しにならず、TOCにも反映されません。 ### タイトル冒頭に#を入れた場合 @@ -90,7 +90,7 @@ facebookが母体なので色々と気になるところですが、[React](http ``` ↓ -:::info #### 見出しになりTOCに反映されるタイトルの例 +:::info #### 見出しになり、TOCに反映されるタイトルの例 #が4つ分のためH4見出しになります。TOCにも反映されます。 @@ -109,7 +109,7 @@ facebookが母体なので色々と気になるところですが、[React](http ::: ``` ↓ -:::info #### 見出しにならずTOCに反映されないタイトルの例 +:::info #### 見出しにならず、TOCに反映されないタイトルの例 #がないため見出しになりません。 @@ -141,7 +141,7 @@ facebookが母体なので色々と気になるところですが、[React](http ### RemarkとRehypeについて -RemarkとRehypeは、markdownをHTMLに変換するプロセスにおいて、AST(抽象構文木・Abstract Syntax Tree)に作用するプラグインです。なお[ASTを操作するオープンソースのエコシステム](https://github.com/unifiedjs/unified)の中にはもう一つ[Retext](https://github.com/retextjs/retext)というプラグインもありますが、Docusaurusには実装されていないようです。 +RemarkとRehypeは、MarkdownをHTMLに変換するプロセスにおいて、AST(抽象構文木・Abstract Syntax Tree)に作用するプラグインです。なお[ASTを操作するオープンソースのエコシステム](https://github.com/unifiedjs/unified)の中にはもう1つ[Retext](https://github.com/retextjs/retext)というプラグインもありますが、Docusaurusには実装されていないようです。 ```md title="markdownからHTMLへ変換処理の流れ" | ........................ process ........................... | @@ -159,7 +159,7 @@ Input ->- | Parser | ->- Syntax Tree ->- | Compiler | ->- Output 上図([Unified Overviewより](https://github.com/unifiedjs/unified?tab=readme-ov-file#overview))にTransformersとあるところがRemark/Rehypeの動作するところ。 -Remarkはmarkdown形式で、RehypeはHTML形式でASTを扱います。どちらも同じようにASTを操作できますが、データ構造が違うため、目的に応じて選択することになるのかなと思います。 +RemarkはMarkdown形式で、RehypeはHTML形式でASTを扱います。どちらも同じようにASTを操作できますが、データ構造が違うため、目的に応じて選択することになるのかなと思います。 [こちらのサイト](https://vivliostyle.github.io/vivliostyle_doc/ja/vivliostyle-user-group-vol2/spring-raining/index.html)などが詳しいです。 @@ -172,14 +172,14 @@ Docusaurusでこれらのプラグインを利用するためにはdocusaurus.co | Remark<br />Markdown形式 | beforeDefaultRemarkPlugins | remarkPlugins | | Rehype<br />HTML形式 | beforeDefaultRehypePlugins | rehypePlugins | -markdownからHTMLへの変換処理のところで、Docusaurusは自前のプラグイン(デフォルトプラグイン)を使い「見出しにidをつける」「ASTからTOCを作成する」などの処理を行っています。そのため今回のように「Amonitionのタイトルを読んでTOCに反映する」ためには、デフォルトプラグイン適用前と適用後の両方のタイミングでの処理が必要になります。 +MarkdownからHTMLへの変換処理のところで、Docusaurusは自前のプラグイン(デフォルトプラグイン)を使い「見出しにidをつける」「ASTからTOCを作成する」などの処理を行っています。そのため今回のように「Amonitionのタイトルを読んでTOCに反映する」ためには、デフォルトプラグイン適用前と適用後の両方のタイミングでの処理が必要になります。 ### Swizzlingについて -Swizzlingは[こちら](https://docusaurus.io/docs/swizzling)に説明がある通りの機能で、簡単に言うとReactのコンポーネントをカスタマイズできる機能です。 +Swizzlingは[こちら](https://docusaurus.io/docs/swizzling)に説明があるとおりの機能で、簡単に言うとReactのコンポーネントをカスタマイズできる機能です。 -Swizzlingの設定をすると、Docusaurusがデフォルトのコンポーネントの代わりに自動的にカスタマイズしたコンポーネントを使用するようになります。 +Swizzlingの設定をすると、Docusaurusがデフォルトのコンポーネントの代わりに自動的にカスタマイズしたコンポーネントを使用します。 今回は、デフォルトのAdmonitionにないID属性を持たせるためAdmonitionコンポーネントをカスタマイズしました。Swizzlingの設定をすることにより、デフォルトのAdmonitionの代わりにこのカスタムコンポーネントが使われるようにします。 @@ -189,7 +189,7 @@ TOCは「ASTに含まれているheading要素を単純に配列に入れてい 1. docusaurusのデフォルトプラグインがTOCの処理を行うより前に、Admonitionのタイトル部を見出しとして新規作成し、Admonition要素の直前に追加する 1. docusaurusのデフォルトプラグインがTOCの処理を行い、Admonitionのタイトル部がTOCに入る。見出しにはidが付与される -1. デフォルトプラグインの処理が終了したら作成した見出しは不要になるので削除する。その際、削除する見出しと同じタイトルを持つAdmonition要素を探し、idを与える +1. デフォルトプラグインの処理が終了したら作成した見出しは不要になるので削除する。その際、削除する見出しと同じタイトルをもつAdmonition要素を探し、idを与える 1. AdmonitionコンポーネントでidをHTMLタグに付与する @@ -343,7 +343,7 @@ export default plugin; :::note Admonitionのツリー構造 -参考までに、Remarkのプラグインから見るとAdmonitionのASTは例えば次のようになっています。 +参考までに、Remarkのプラグインから見るとAdmonitionのASTはたとえば次のようになっています。 ```javascript title="Admonitionのツリー構造(一例)" { diff --git a/blog/2024/01/31/sagawa-aiki-kouen-seibi-joukyou/index.mdx b/blog/2024/01/31/sagawa-aiki-kouen-seibi-joukyou/index.mdx index 517fb95f..17bbd7e5 100644 --- a/blog/2024/01/31/sagawa-aiki-kouen-seibi-joukyou/index.mdx +++ b/blog/2024/01/31/sagawa-aiki-kouen-seibi-joukyou/index.mdx @@ -18,7 +18,7 @@ img: IMG_1825.jpg 合気公園に関してこれまでの経緯はこちら↓にまとめています。 - [旧佐川邸の公園化を考える会・これまでの経緯(2)](https://sagawa-aiki-park.com/keii-2/) -- [請願第5号 旧佐川邸の土地を売らないことも含め、市民の意見を聞きながら公園整備を行うことについて](https://yasutakeyohei.com/books/reiwa3/20210219_teireikai/seigan-5.html) +- [請願第5号 旧佐川邸の土地を売らないことも含め、市民の意見を聞きながら公園整備を行うことについて](https://yasutakeyohei.com/books/reiwa3/20210219_teireikai/seigan-5.html) ### 市民による公園整備案 @@ -36,7 +36,7 @@ img: IMG_1825.jpg この整備イメージに基づいて整備が進んでいます。 ## 写真 -以下の写真と動画は令和6年1月30日(火)に撮影したものです。 +次の写真と動画は令和6年1月30日(火)に撮影したものです。 ### お知らせ ![合気公園整備中・お知らせ](IMG_1825.jpg) @@ -93,7 +93,7 @@ img: IMG_1825.jpg ### 佐川氏が四股を踏んでいたとされる石 -右下の平らな石が佐川幸義氏が四股を踏んでいたとされる石です。 +右下の平らな石が、佐川幸義氏が四股を踏んでいたとされる石です。 ![合気公園整備中・四股を踏んでいたと思われる石](IMG_1853.jpg) @@ -108,7 +108,7 @@ img: IMG_1825.jpg ### 西側の工事看板・目隠しフェンス上部 -目隠しフェンス上部は人が乗り越えられないような突起が出ています。 +目隠しフェンス上部は人の乗り越えられないような突起が出ています。 ![合気公園整備中・西側の工事看板・目隠しフェンス上部](IMG_1856.jpg) @@ -117,9 +117,12 @@ img: IMG_1825.jpg ## 動画 +{/* <!-- textlint-disable --> */} + import {Tweet} from 'react-tweet' <Tweet id="1753261480265527582"/> +{/* <!-- textlint-enable --> */} 以上です。完成が楽しみですね。
\ No newline at end of file |