タグ

markdownとオープンソースに関するyohane00のブックマーク (3)

  • Docusaurus - Facebook製のオープンソース・ドキュメントサイト MOONGIFT

    開発ドキュメントの整備は大きな問題です。ソースコードに書かれたりWikiや何らかのCMSを使ったりと様々な方法がありますが、これといった解決策はなかなか見つけられません。 そこで使ってみたいのがDocusaurusです。Facebook製のオープンソース・ドキュメントサイトです。 Docusaurusの使い方 メインページです。 文書はMarkdownで作成します。 ドキュメント部分です。左側に目次、右側にコンテンツが表示されます。 リンクはページ下に付きます。 DocusaurusのコンテンツはMarkdownとなっています。それだけにメンテナンスが容易です。また、UIReactで作られていますので、表示が高速に行われます。オープンソースのプロジェクトに最適なドキュメント管理かも知れません。 Docusaurusはnode/JavaScript製のオープンソース・ソフトウェア(MIT

    Docusaurus - Facebook製のオープンソース・ドキュメントサイト MOONGIFT
  • Docbase - Markdownから生成する開発者向けドキュメント

    MOONGIFTはオープンソース・ソフトウェアを紹介するブログです。2021年07月16日で更新停止しました 開発者向けのドキュメントはDX(Developer Experience。開発者体験)を語る上で欠かせない存在です。ドキュメントが間違っているのはもっての外ですが、さらに可読性が高かったり、機能面においても体験を向上できる要素があります。 そんな中、メンテナンスのしやすさもまた大事な要素になります。今回はMarkdownファイルをベースにしたドキュメントシステム、Docbaseを紹介します。 Docbaseの使い方 利用例です。トップページのデザインも格好良いです。 ドキュメント詳細です。右側に目次、中央にコンテンツが表示されます。 コードは文字が大きく見やすくなっています。 別なドキュメントの例です。ヘッダーやフォントなどをカスタマイズできます。右側のカラムは表示されていません。

    Docbase - Markdownから生成する開発者向けドキュメント
  • Sharedocs - 社内で使えるQiitaクローン

    MOONGIFTはオープンソース・ソフトウェアを紹介するブログです。2021年07月16日で更新停止しました 強い組織を作るためにはナレッジの共有が欠かせません。個々人のナレッジに留まっていては同じ経験を繰り返すだけですし、何も培われていきません。問題はどこに書き留めるかです。かつてはWikiもありましたが、慣れないと使いこなせませんでした。 今回紹介するオープンソース・ソフトウェアはSharedocs、プログラマが使い慣れているであろうQiitaクローンです。 Sharedocsの使い方 Sharedocsのトップページです。 ログインしました。カラーリングは違いますが、UIはとてもQiitaに似ています。 新規作成画面です。ここのデザインは結構違います。が、プレビューの機能などはついています。 表示例です。記法はMarkdownが使えます。 ユーザページです。投稿数、ストック数などが確

    Sharedocs - 社内で使えるQiitaクローン
  • 1