MarkdownとPHPで編集できるので簡単
現代の大規模システムなどのデータはSQLというデータベースから持ってくるものではありますが、最近は便利な機能としてマークダウン(Markdown)も注目されています。特にGitHubのREADME.mdは、そのディレクトリの下に表示されて便利です。
しかし共有サイトでは実際に動くプログラミングなのかを確認する方法が少ないです。それを改善したのが本プログラミングとなります。以下がその長所です。
1. マークダウンによる簡単な編集
- Markdownファイルを使った編集が可能なので、書籍やドキュメントの内容を簡単に更新できます。Markdown形式はテキストベースで軽量なため、専用ソフトを必要とせず手軽に修正や追加ができます
- Markdownの長所はHTML書類はデータを内包しますので、後で他のプログラミングに移植がしづらい方法と違い移植しやすく、現代は多くの有名サイトなどで利用されています
- HTMLタグを知らなくても、数少ないマークダウン記述を覚えたら編集可能です
- HTMLタグよりも文字数が少なくなるので、ミスが減ったり速度も少しは向上します
- HTMLタグを使うのも可能です
- マークダウンは複雑なレイアウト(CSS)の記述は出来ません
- 他のサイトでは使えてもここでは使えないマークダウン記述もあります
2. 明暗モード切替機能
- ページ全体のテーマを「明るいモード」と「暗いモード」の2種類で切り替えられます。閲覧環境に合わせて、目に優しい背景色が選択でき、夜間や暗い場所での利用が快適になります。
- 周辺が明るい時のPCの液晶ディスプレイは見づらいこともあるので、切替えると改善するかもしれません
3. レスポンシブなメニュー
- メニューが画面の大きさに合わせて自動で表示を最適化します。スマートフォンやタブレットからも見やすく、タッチ操作に対応しているため、利便性が向上しています。
- フレキシブルなHTMLにしてますが、他のサイトのように数多くの要素をつけると読書に集中できなくなるので、スマホの小さい画面で見やすくするのを主にしています
4. 自動ページタイトルの表示
- マークダウンファイル内に設定されたタイトルを読み込み、自動的にページタイトルを設定します。著述家などはMarkdown内の内容を変更するだけでページ全体が自動更新されるため、手間がかかりません。
5. 簡単なページナビゲーション
- ページ上部のメニューから、異なるMarkdownファイルにワンクリックで移動できます。さまざまな内容にアクセスしやすく、閲覧者は迷わずコンテンツを楽しめます。
- ナビゲーションがあるので、無駄に多くて不要である冗長になる静的な目次ページはありません
- ナビゲーションが無いと、小さい画面のスマホは見えづらいです
6. JavaScriptでのテーマ保存
- ユーザーの好みに応じたモードを記憶できる機能があります。ページを再訪問しても、直前に選んだテーマ(明るい・暗いモード)が維持され、快適な体験が続きます。
7. セキュリティとエラー対応
- 不正なファイルフォーマットやファイルの欠如に対するエラーメッセージが表示されるため、プログラマーは問題の発生時にすぐに原因を把握し、対処できます。
- マークダウンの記述ミスをWebページで確認できるPHPプログラミングをしました
8. docusaurusのマークダウン書類をそのまま移植可能
- docusaurusとはFacebookのMeta社がReactで開発したWebフレームワークです。しかし2022年に使用したら、2024年にはデプロイが出来ませんでした。理由はNode.jsの最新機能にソースが合ってなかったらしいです。他のサーバーに移植する場合、Node.jsで稼働しているサービスが多くなく、PHPは多くで対応しています。しかしモダンなReactのマークダウン書類をPHPにバージョンダウンするようなことをすると、今後また新しいフレームワークに移植したいという拡張性からして、このようにしました。
- docusaurusでは可能でもこのプログラミングでは不可能といいますか、厳密にマークダウンをHTML化する場合があり、そこで表示に不具合が出る場合があります。例えば箇条書きリストの下に箇条書きに含めたくない文字を表示させたい場合に、空白1行以上を入れないとインデントを作り、箇条書きに含めてしまう場合があります。
9. モダン言語よりもPHPの方が簡単にレイアウトなどが可能
- このプログラミングはモダン言語ではないPHPを利用しているので、マークダウンの一部の高機能には対応していません。ただしモダン言語ほどPHPは複雑ではないので、簡単にレイアウトが出来ます。
10. 大企業などの大規模システム向きではないかもしれませんが中小企業や個人向けで軽快
- 大きなサイトでもPHPは使用しているので、大規模システムで不向きではないかもしれませんが、モダン言語よりは速度が遅くなったり、多機能ではない場合もありえます。
- 速度が遅いのと軽快は矛盾しているように見えますが、多機能だと要らない機能がありながらもウイルス感染対策などで複雑になりえます。学習コストも多機能だと増えます。