15
7

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

ブックマーク迷子に捧ぐ!MkDocs × GitHub Pagesで「便利リンク集」を爆速構築してみた

Posted at

Qiitaの投稿が久しぶりすぎ戸惑ってます。
おはようございます、こんには、こんばんは、やないです。

突然ですが、気づけばブラウザのブックマークが「カオスの海」になっていませんか?
\アルアルー/ \ソレナー/ \ワカルー/ \ウルセー バーカ/
そうですよね、みんな同じ道を歩みますよね(遠い目)
最後にアンチが混ざってるみたいですが先に進みましょう

私の場合、「これブックマークしとこ」→3日後→「結局Google検索で新しいの見つけちゃった」という無限ループにハマっていました。

そんな中、おぼろげに浮かんで来たんです。
「もういい加減、自分専用の便利リンク集を作ろう」と。

ブックマーク王に俺はなる!

熱い思いを胸に秘めつつ、「だめよ、せっかく作っても自己満足になってはいけない!どうせ作り終わったら満足して運用しなくなるんだから」
またも聞こえてくる (おそくらく)今田美桜そっくりの 女神様からの啓示

よっしゃ、ここはいっちょエンジニアっぽくGitHubで公開して、みんなで育てる“集合知ブックマークサイト”とでもしてやりますか

あたい、日本中のブクマ迷子を救ってみせるわ!

ってノリで作りました

👉 Github

実際に稼働してるサイトはこちら
👉 FUL (Find Useful Links)


なぜ作ったのか?

まぁ、上記に色々書きましたが、真面目な話としては完全に 自分用のメモ でした。
女神様の啓示はかなり有効で自分でも「運用しきれないだろうな」と思いました。

なのでこのサイトを見てもらえるかわかりませんが、Githubで公開したら誰か気づいてくれるかなと。
もしかしたら同じくブックマーク迷子の人に刺さって一緒に成熟させてくれるのでは?
リンク切れ地獄も気づいたタイミングで修正してくれるのでは?

まぁ、あれです。
THE 他力本願
ド◯えもーーーん!ブックマークの修正できる便利な道具だしてよー(泣)
泣いんでんじゃねーよ!!(情緒不安定)

そんなわけで、ただリンクを増やすだけでなく、リンク切れを見つけたらPRで削除する流れ にしようと思った次第です。
「気づいたら半分以上リンク切れ」という“放置リンク集あるある”を避けたいので、更新や削除もみんなで回していければと考えています。


なんでWikiじゃなくてGitHub?

そもそもWikiにすれば良いじゃん。って思ったあなた!
わかります。自由に編集できた方が良いじゃんって私も思います。

でも私はあえてGitHubにしました。理由はシンプル。

  1. 精度を保ちたい
    Wikiだと「昨日の夜テンションで追加した謎リンク」みたいなのが混ざる可能性大です。
    GitHubならPRベースでレビューできるので、ある程度のフィルタリングが効きます。
    まぁ私の判断次第にはなりますが、、、

  2. Forkの練習にちょうどいい
    「GitHubは触ってるけど、Forkってやったことないんだよね…」という人、多いのでは?
    このリンク集なら「まずForkして追加してみよう」という軽いチュートリアル代わりになったりならなかったり


とにかく早く楽にするためにMkDocs

そんなわけで早速作り始めます。

使ったのは MkDocs + GitHub Pages。理由は簡単、楽だからです。

もうね、ほんと日本人頑張りすぎだから肩の力抜こう
早く返信して早くアップする!
そして
あまったじかんで なにしよう
あっ、それ まいたけまいたけぐるぐる
まいたけまいたけぐるぐる
まいたけまいたけぐるぐる

  • Markdownでそのまま編集可能(Qiitaに慣れてる人ならノータイムで参戦可)
  • pip install mkdocs mkdocs-material で環境完成
  • mkdocs gh-deploy 一発で公開

なんとこれだけで「えっ、あたい、こんなオシャレなサイト作ってる!?」と錯覚できます。
※個人の感想です。

デザインセンスのある方、ぜひビジュ良いじゃんって言われるように調教してあげてください

ちなみにテーマは Material for MkDocs。デフォルトで“ちょっとドヤれる感”が付属してきます。

ローカルでの立ち上げも秒でできます。

pip install mkdocs
pip install mkdocs-material
mkdocs new my-docs
mkdocs serve

すいません、ここでは紹介用にしてますがGitHubのREADMEにはもうちょい細かく書いてあるので参考にしてください

http://127.0.0.1:8000 を開くと即プレビュー。編集内容も即反映。
「えっ、これもうVSCodeより快適じゃない?」ってなります。

まぁ僕はneovim使ってるんですけどね(ウザ顔)
※超ペーペーのにわかですごめんなさい怒らないで
※エディタと野球と政治の話は良くないって死んだ祖父母が言ってました


運用はゆるふわ

  • カテゴリごとに整理 → 「文字列処理」「地理系」「開発ツール」など、迷子にならない設計
  • 開発者だけじゃない → エンジニア向けツールはもちろん、旅行や生活に役立つサイトもあり。非エンジニアでも楽しめる“雑多だけど便利”なジャンル構成になっています。
  • 更新はPRベース → 「このサイトめっちゃ便利!」と思ったらPRでどうぞ。
  • リンク切れは削除 → 見つけた人がPRで消す。健全に整理される仕組みを目指しています。
  • 自動デプロイ? → 今はまだ mkdocs gh-deploy を手で叩いてます。将来的にはGitHub ActionsでCI/CDにする予定ですが、正直「手動でも割と楽しい」ので後回し中です。

今後どうなるの?

現時点では私の“独断と偏見リンク集”ですが、これからはみんなで育てていきたいです
理想はこんな未来です👇

  • ジャンルがどんどん広がる
    開発者向けのツールだけじゃなく、旅行、学習、生活ハックなども追加されて「気づけば百科事典級!」になるかもしれません。

  • 自分に合ったサイトがすぐ見つかる
    「今日は英語学習したい」「明日は天気を調べたい」みたいに、その時のニーズに合わせてサクッと使えるリンク集に。

  • コミュニティで成熟していく
    みんながPRを出して、レビューを通じて「これは本当に便利だ!」と認められたサイトだけが残る。つまり“厳選リンク集”になっていきます。

  • GitHub学習にもなる
    Fork → 修正 → PR という流れを実際に体験できるので、「便利リンク集に貢献したらGitHubスキルも上がった」という一石二鳥感も。

とか大義名分語っちゃってますけど、皆が使ってくれたら嬉しいです
メンテナンスはめんどくさいけどサイト追加したいって人はGoogle Formからリクエストできるようにしてますので


まとめ

  • 自分の備忘録から始まったリンク集
  • GitHubを活用してみんなで育てるスタイルに
  • MkDocsのおかげで爆速サイト構築
  • 非エンジニアでも役立つリンクが多数!
  • リンク切れは削除して常に健全な状態を維持!

気になる方はぜひ覗いて、そしてPRで参加してください。

エッホエッホ、ブックマークを皆で管理しよって伝えなきゃ、エッホエッホ

15
7
1

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
15
7

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?