タグ検索の該当結果が少ないため、タイトル検索結果を表示しています。
プロジェクトドキュメント構築向け静的サイトジェネレータ『MkDocs』及び『Material for MkDocs』の個人的導入＆設定まとめ | DevelopersIO
プロジェクトドキュメント構築向け静的サイトジェネレータ『MkDocs』及び『Material for MkDocs』の個人的導入＆設定まとめ 直近携わっているプロダクトで「ユーザーガイド」的なドキュメントを作る機会があり、暫く前に幾つか見繕ってみた結果「MkDocs」というツールを選定して環境を作成＆整備して来ました。個人的にこのツールは使い勝手がとても良いと思っており、継続して使って来ていました。 当エントリでは今後の備忘録としてMkDocsの基本的な導入・設定方法と、そのMkDocsで適用させたスタイル「Material for MkDocs」をここまで使ってきた中での個人的Tipsなどをまとめておきたいと思います。 MkDocs Material for MkDocs - Material for MkDocs 目次 MkDocsとは MkDocsのインストール 基本操作 各種設定・
MkDocsによるドキュメント作成
📌 はじめに mkdocs は 静的サイトジェネレータです。コンテンツは基本的に markdown 形式で記述したソースファイルになります。またHTML形式のファイルを使うことも出来ます。この記事では Windows で個人的な最低限の作成環境をまとめました。 MkDocs 📌 mkdocs のインストール python をインストールします。今回は 3.9 で試しました。なお、私の環境は Windows+miniconda で構築しています。 次に pip を使って mkdocs をインストールします。 pip install mkdocs 動作環境は次のとおりです。 python 3.9.5 mkdocs 1.4.2 mkdocs-material 8.5.11 mkdocs-material-extentions 1.1.1 pymdown-extensions 9.9 📌 プ
何番煎じだろうと書く。 顧客向けマニュアルをMarkdownで作りたい ここ最近、社内で利用する仕様書だったり手順書だったりはCrowiでMarkdownで書いています。Markdown、手軽で便利ですよね。 ただ、お客様に提出するような製品仕様や製品マニュアルを公開するのは、セキュリティとかアカウント管理とかの関係でちょっと公開するのはいかがなものかなと。 記事のエクスポート機能でもあればなーと思っていたところで、MkDocsに出会いました。割と感動したので、この感動を皆様と共有したく。 公式サイト 何が凄いのか Markdownでドキュメントが書ける webサービスを内蔵しているので、わざわざwebサーバーを立てなくてよい webサービスはMarkdownへの変更をリアルタイムに反映してくれる テーマが選択できるのでデザインセンスがなくても割といい感じにしてくれる 1コマンドで静的サイ
プロジェクトドキュメント構築向け静的サイトジェネレータ「Material for MkDocs」の色々な設定を試してみる(ナビゲーション編) | DevelopersIO
プロジェクトドキュメント構築向け静的サイトジェネレータ「Material for MkDocs」の色々な設定を試してみる(ナビゲーション編) 下記エントリで紹介したプロジェクトドキュメント構築向け静的サイトジェネレータ「Material for MkDocs」。日々アップデートが行われており、便利な機能や設定が利用出来るようになっています。 このエントリでは「現時点での最新バージョンではどんなことが出来るのか」という観点で、Material for MkDocsの「ナビゲーション」に関する項目を色々試してみた内容を紹介します。 目次 初期環境設定とコンテンツの準備 「Material for MkDocs」で利用可能な主な設定 インスタントローディング ナビゲーションタブ設定 ナビゲーションのセクション表示 ページ内容を初期表示で全て「展開済み」の状態に 「ページTOPに戻る」ボタンを表示
MkDocs+GitLab-CI+wkhtmltopdf でドキュメント更新作業の煩雑さから解き放たれる｜Mars
マニュアルの管理運用をやってるのですが、WORD だったり PPT だったり Sphinx だったりで作った資料をGドライブに格納して社外向けに配るときは PDF を zip してパスかけて BOX にあげて共有用 URL をメールで送って、解凍パスワードを別送するとかもう嫌だ！ と思ったので、これからのスタンダードはこれにすると決めたときにやったこと。 🍄 前提Windows 利用者向け 🍄 MkDocs を使える環境を整えるMkDocs は markdown 形式で簡単にドキュメントが作成できるツール。無料です。 python がいります。2.x 系でも 3.x 系でも。なければインストールを。 $ python --version Python 2.7.12pip で mkdocs をインストールするので、存在しているか確認。 $ pip --version pip 9.0.1
プロジェクトドキュメント構築向け静的サイトジェネレータ「Material for MkDocs」の色々な設定を試してみる(ヘッダー編) | DevelopersIO
プロジェクトドキュメント構築向け静的サイトジェネレータ「Material for MkDocs」の色々な設定を試してみる(ヘッダー編) 下記エントリで紹介したプロジェクトドキュメント構築向け静的サイトジェネレータ「Material for MkDocs」。日々アップデートが行われており、便利な機能や設定が利用出来るようになっています。 このエントリでは「現時点での最新バージョンではどんなことが出来るのか」という観点で、Material for MkDocsの「ヘッダー」に関する項目を色々試してみた内容を紹介します。 目次 初期環境設定とコンテンツの準備 「Material for MkDocs」で利用可能な主な設定 ヘッダー部分の表示を隠す ヘッダー上部の「アナウンスバー」をカスタマイズ mkdocs.ymlテンプレートファイル(設定追記済) まとめ 初期環境設定とコンテンツの準備 初期環
はじめに おひさしぶりです。しがないOLくにきちです。久々のブログ投稿になりました。 最近はドキュメント整備を主な仕事にしてまして（たまにリファクタリングやテスト）新しくドキュメント環境作ってみたりドキュメント書いたりして過ごしてます。 その中で、これまでドキュメント作成に使用していた GitBook CLI の開発が止まってしまったため、新しいドキュメント生成ツールを導入しよう！ということになりました。 導入の条件は色々ありましたが、今回導入に至ったのは「MKDocs」です。 簡単で、プラグインの豊富さやモダンな見ため、既存のドキュメントよりも見やすくなったのが決め手でした。 MkDocs の導入については、すでに弊社しんや (shinyaa31) による導入手順ブログ「プロジェクトドキュメント構築向け静的サイトジェネレータ『MkDocs』及び『Material for MkDocs』の
MkDocsでmarkdownなサイト作り
Table of Contents 作成したもの 作成したサイトとGitHubのリポジトリは以下です。 サイト 経緯 アウトプットの先 学びをアウトプットすることは大事です。 私の場合はアウトプットとして、このブログに投稿していました。 しかし、ブログを書くまでも必要ないアウトプットもあります。 参考リンクを貼るだけで解決する場合 (公式の最新を見た方が信頼できる) インターネット上で既に似たような情報が多数見受けられる場合 このようなケースをどう扱うか悩んでいました。 GitHubのリポジトリにノウハウを GitHubはインターネットからアクセスでき、全文検索も可能です。 ブログを書く必要のないものはGitHubのリポジトリにまとめていました。 しかし、しばらく使っていると以下の要望が出てきました。 GitHub Markdown以上のリッチな機能を使いたい 自身の経歴などを記載したポー
この記事は BrainPad AdventCalendar 2023 14日目の記事です。 はじめに こんにちは。毎年この時期だけ活動して、なんとなくやっている雰囲気を出すのが得意な@yagizoです。 最近は開発系組織のいろいろなところに首を突っ込んで(いくつかの組織を兼務して)、エンジニアの組織運営を支援したり、エンジニアと他の部署のハブとして奔走したり、既存のプロダクトに新しい武器(機能)を授けるために企画・開発をしたり、新しいサービス企画検討をしたりと、忙しくも充実した日々を送っております。 さて、本題です。 みなさん、開発のドキュメント（APIや機能などプロダクト、サービスの仕様書、説明書）って、何を使って書いていますか？ 私の所属するチームでは、普段 Sphinxを使って、プロダクトのユーザーガイドなどのHTMLドキュメントを作成しているのですが、「Sphinxってなんでもでき
まとめ 今回紹介した設定ファイルはこのような感じです。(カラー設定確認用のファイル (sample.md) については、「事前準備」に記載していますので割愛します) mkdocs.yml site_name: ドキュメントテスト theme: name: material # サイトの言語設定 language: ja features: # トップに戻るボタン - navigation.top # 配色設定 palette: - scheme: default toggle: icon: material/toggle-switch-off-outline name: ダークモードに切り替えます。 - scheme: slate primary: red accent: red toggle: icon: material/toggle-switch name: ライトモードに切り替えま
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Markdownでドキュメントが作れるMkDocsが便利過ぎる - Qiita
MKDocs – 拡張プラグイン集(1) | DevelopersIO
MkDocsを使って、簡単にドキュメント公開♪ - Qiita
MKDocs – 基本のドキュメント配色設定方法 | DevelopersIO
b.hatena.ne.jp
www.goodrooms.jp
www.sankei.com
togetter.com
tonarinoyj.jp
powerspot-japan.hatenablog.com