プロジェクトドキュメント構築向け静的サイトジェネレータ『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のインストール 基本操作 各種設定・
エンジニアが画面設計（Figma）を担当してみた振り返り
Thinkings株式会社 では sonarATS の開発にあたり、基本的にはデザイナーがFigmaを作成し、それに基づいてエンジニアが開発するというフローを取っています。 そんな中、先日エンジニアサイドで画面設計を行ってみるという実験的な取り組みをしました。 本記事では画面設計を行うことになった経緯と具体的な取り組み内容を振り返り、エンジニアが画面設計をすることのメリットと課題感について考えたことをまとめたいと思います。 エンジニアサイドで画面設計をするきっかけとなった要因 エンジニアサイドで画面設計をすることとなった理由として、大きく分けて以下３つの要因がありました。 デザイナータスク削減の目標 あるマスタ画面を開発したときの課題感 上述の通り、『簡単なマスタ画面の開発』のような共通的な画面設計になる機能については、できるだけデザイナーが介入せずエンジニア主導で開発している → 実際に
主にVSCodeではじめるPython開発環境構築ガイド | DevelopersIO
ファイル比較 VSCodeのエクスプローラで、ファイル２つを選択して右クリックメニューから「選択項目を比較」で比較することができます。 また右クリックで、「比較対象の選択」をした後に「選択項目を比較」でも比較することも可能です。 VSCodeのSnippetの使い方 VSCodeのSnippetも便利です。似たような構造のクラスを実装する場合などや、プロジェクト共通で使いがちな書き方というものをSnippetに登録して、効率化することができます。 また、変数を持たせておくこともできます。この場合、Snippetを呼び出した後に変数部分にカーソルがあたるので、そこで変数部分をタイピングできます。 詳細は以下のリンクをご覧ください。 Visual Studio Codeに定型文（スニペット）を登録する方法 VSCodeのUser Snippetを活用しよう！ また後述するSnippet Gen
ChatGPTで業務フローが自動的に書けた｜Yuji Inagaki
こんにちは。ユアマイスターでプロダクトマネージャーをしています、稲垣といいます。 最近、業務でChatGPTを使いまくっているのですが、ちょっと個人的に感動する使い方を見つけたので紹介します（既に知ってるぞ！という方、すいません）。 プロダクト開発において、業務フローって必要になること多いですよね。でも書くの大変。Draw.ioとかFigmaとか便利なツールも出てるけど、それでも大変。 さあ、下記のようにプロンプトを書いてみましょう。 一般的な受注業務の業務フロー図を作りたいです。Mermaid Markdown形式で出力してください。 # 制約条件 - 「・」「?」は使用しないでください ChatGPTの出力結果のこれをコピーして、 Notionに貼りましょう（「コードブロック」を選択してください）。 「コード」を選ぶこの領域にペーストするすると・・・。 うおおおおお。 業務フローが自動
VSCodeで最強のMarkdownノートエディタを作ろう
昨日の自分「今作ってる曲まじで良すぎる。天才かもしれん」 今日の自分「ﾅﾆｺﾚ。曲作り下手すぎか～～」 この記事は新歓ブログリレー23日目の記事です。 こんにちは、カシワデと言います。サウンド班に所属していてパソコンで音楽を作っています。 皆さん、DTMってしってますか？ DTMとはDeskTop Musicという和製英語の略で、パソコンで音楽を作ることを広く指します。パソコンで音楽を作ると言っても昨今の曲は大体パソコンを用いて作られているので、DTMというと特に"打ち込み"のニュアンスが出るような気がします。 でも、『パソコンで音楽を作る～』とか『打ち込み』っ… 🎉入学おめでとう🎉まずは新入生の皆さん、ご入学おめでとうございます！！！これから始まる大学生活は非常に短いですし、世間で言われる程時間に余裕があるわけでは無いので、後悔の無い充実した生活を送ってください！
技術文書の書き方
howto-tech-docs.md 技術文書の書き方 このメモは、私（@ymmt2005）が長年にわたってソフトウェアプロダクト開発に関わってきて 2022年現在こうしたほうが良いと考えているベストプラクティスです。 科学的な分析等に基づくわけではない経験則であるため、今後も随時見直すことがありますし、 ここに書いてあることが常に正しいわけでもあらゆるソフトウェア開発に適するわけでもありません。 しかしながら、実務経験が豊富で、モダンな技術スタックに明るいエンジニアの経験則は一定の 役に立つのではないかと考えて記します。 技術文書とは ここでは、ソフトウェア開発で技術者が書くべき文書ということにします。 ソフトウェアエンジニアにも役割がいろいろあり、アーキテクトと independent contributor では書く文書が違うということはあるでしょうけれど、ここではごっちゃにします。
ExcelやGoogleスプレッドシートをMarkdown出力するVS Codeの拡張機能「Excel to Markdown table」が便利すぎる件 | DevelopersIO
Markdownでテーブルを表現するにはつらみが深すぎる みなさんはMarkdownでテーブルを書くことは得意ですか? 私は苦手です。 簡単なテーブルは簡単に書けるのですが、以下のようなテーブルを書くことには抵抗感があります。 行数、列数が多い セル内に書くテキスト量が多い セル内でリストを表現する 一方、私は先日、「Markdownで手順を書いています!」とこちらの記事で伝えました。 そんな私に対して、 「オイオイオイ。 Markdownでもなんでもいいけどよォ... テーブルを使いたい場面は多いんだぜ。」 というセリフが聞こえてくる気がします。 私のようなMarkdownでテーブルを書くことにつらみを覚える方への解決策として、以下記事で紹介している「MarkdownTableMaker」があります。 このアドオンを使うことで、選択したスプレッドシートをMarkdownに出力してくれます
Top 10 VS Code extensions for 2021 - LogRocket Blog
Ashutosh Singh Ashutosh is a JavaScript developer and a technical writer. He writes about the fundamentals of JavaScript, Node.js, React, Next, Vue, and tutorials on building projects. Visual Studio Code is one of the most widely used code editors in the developer community. One of the reasons for VS Code’s popularity is its many extensions that speed up the development process. In this guide, we’
Markdown で技術書が書ける｜abechanta
ソフトウェアに関する記事やコラムを書くなら、Markdown 記法はとても良い選択です。見た目の統一感があり、覚えやすく、軽量です。 この「Markdown での書きやすさ」を物理書籍や電子書籍の執筆にも応用できたらな、、、 "W3C Paged Media Viewer" はそれを実現する、OSS の Visual Studio Code のエクステンションです。エクステンションを入れただけの超シンプルな環境を使って、手間いらずでサクッと技術書を執筆することができます。 以下に示すとおり導入は簡単です。 1. VS Code を起動します 2. CTRL + SHIFT + X とタイプして Extensions ビューを表⽰します 3. 検索ボックスに paged media と⼊⼒し、 W3C Paged Media Viewer あるいは abechanta.vscode-ext-
Electron製アプリの起動速度を1,000ミリ秒速くする方法
めっちゃダッシュするイヌさん英語で先に書いてから日本語訳しています ⇒ English version is available here. こんにちは、TAKUYAと申します。InkdropというMarkdownノートアプリを開発しています。このアプリはElectronで作っています。Electronは、NodeJSとChromium(ブラウザ)ベースでクロスプラットフォームなデスクトップアプリが開発できるフレームワークです。このフレームワークは基本的に素晴らしいです。なぜならあなたはネイティブ用のフレームワークを学ぶ必要がなく、JavaScript、HTMLとCSSでアプリが作れるからです。もしあなたがウェブデベロッパーだったら、手軽にアプリが作れるでしょう。一方で、多くの人がElectronの弱い点についても言及しています。それはアプリの起動速度が遅い傾向にある、という点です。僕のア
「Visual Studio Codeの教科書」を読んでVS Codeの設定をゼロから見直してみた - karaage. [からあげ]
追記：VS Codeの入門書をZennでリリースしました ブログで扱ったVS Code関連の記事をまとめて、無料の電子書籍としてZennというプラットフォームでリリースしました。よければ、こちらも参考にしてみてください。 Visual Studio Codeの教科書 Visual Studio Codeの教科書を購入しました。基本的な使い方から拡張機能の作り方まで、広く押さえられていました。 プログラマーのためのVisual Studio Codeの教科書 (Compass Booksシリーズ) 作者:川崎 庸市,平岡 一成,阿佐 志保発売日: 2020/04/30メディア: Kindle版 自分は拡張機能作りには興味なかったのですが、思わず手を伸ばしたくなりますね。拡張機能作りまで興味ある方にとってはかなり良い本ではないかと思います。 本を読むと、色々改めて発見があったのと、拡張機能一回
![「Visual Studio Codeの教科書」を読んでVS Codeの設定をゼロから見直してみた - karaage. [からあげ]](https://cdn-ak-scissors.b.st-hatena.com/image/square/b8cf77980ab900ed339768901e94cfe2584441d7/height=288;version=1;width=512/https%3A%2F%2Fcdn-ak.f.st-hatena.com%2Fimages%2Ffotolife%2Fk%2Fkaraage%2F20200707%2F20200707003818.png)
Visual Studio CodeからQiitaに投稿できる拡張機能をつくってみた - Qiita
VSCodeで編集中のMarkdownファイルを一発でQiitaに公開できるスマートな拡張機能があればいいな〜と思ってGoogleで検索したら こちらの記事 がヒットしたのですが、どうやら開発が滞ってしまっていたようで、同様のものを開発しても良いかをコメントでお尋ねしたところ快諾してくださったので公開してみました。 GitHub （★ください） インストール （現時点ではプレビュー版です） 途中でTypeScriptのコンパイラーのバグを踏んでデバッグできなくなって発狂しそうになりましたが、なんとか必要最低限の機能は実装できたので所感を書いておきます。 Visual Studio Codeの拡張機能について VSCodeの拡張機能は基本的にTypeScriptで実装できます。直接DOMの操作ができず、提供されたAPIの中で頑張らなくちゃいけない設計なので、はじめは覚えるのに苦労すると思いま
TsumiQiita - ローカルに書きためられるQiitaクライアント
プログラマでQiitaを使っている人は多いでしょう。そして、とりあえずメモ代わりに書いておいて、下書きのまま放置されている投稿も多いのではないでしょうか。そして書き残しが多くて整理するのも面倒になります。 そこで使ってみたいのがTsumiQiitaです。ローカルで動くので、Markdownエディタ代わりに使うこともできます。 TsumiQiitaの使い方 メイン画面です。 本来は投稿もできるはずなのですが、筆者環境ではうまく動きませんでした。普段はMarkdownエディタとして使いつつ、面白そうなネタができたらQiitaに投稿するといった使い方ができます。保存は自動で行われるので、保存忘れもなく、さくさくと書きためられるでしょう。 TsumiQiitaはElecron/JavaScript製のオープンソース・ソフトウェア（MIT License）です。 hidao80/TsumiQiita
algoliaを使ってJekyll製ブログに全文検索をつけた話
algoliaとは Products to accelerate search and discovery experiences across any device and platform. algoliaとは全文検索エンジンサービスです。「algoliaサーバにブログやドキュメントなどのコンテンツデータをアップすると、そのデータを全文検索するAPIを利用できる」といった感じのものです。 例を挙げると、Vue, React, Webpack, babel などの公式ドキュメントにある検索機能が、algoliaのDocSearchという機能によって実現されています。 今回は、このalgoliaを使ってブログに全文検索を実装した方法をまとめてみます。 手順 algoliaのフリーアカウントを取得する jekyll-algoliaを使い、ブログコンテンツをalgoliaサーバにアップする a
TODO.md Kanban Board - Visual Studio Marketplace
Todo Kanban Board Todo Kanban Board manages tasks and save them as TODO.md - a simple plain text file. Features The syntax is compatible with Github Markdown TODO.md file is portable and can be committed with Pull Requests (PRs) to git repositories. Support custom file name, multiple task lists. Checkboxes are optional (if your task titles don't have them). Task title can also have markdown for st
プレーンテキスト Markdown 時代の終焉
なぜ Day One は Markdown を捨てたのか Day One が Markdown をやめて WYSIWYG に移行した話は前書いた。 Day One がクソになった Day One 、このブログでも度々言及していて、 Markdown で日記が書けて便利だったんだけど、最近のバージョンアップ（ Mac は 2.8 以降 、 iOS は 3.0 以降）でプレー... portalshit.net 自分が知っている範囲でアンチ Markdown 勢は Scrapbox くらいしか思い浮かばず、 GitHub や Trello などのグローバル勢に加え、 Qiita やはてなブログなど日本国内向けのサービスでも当然のように Markdown が共通言語として使われているのに、その Markdown を捨てて WYSIWYG 化する1という戦略は疑問だった。 ひとむかし前の WYSI
HackMD: Your Collaborative Markdown Workspace for Knowledge Sharing
Get HackMD free HackMD is my go-to thinkpad. It's been a great fit for everything from TODO lists to Ethereum devnet specs, drafting blog posts and all types of internal org docs. It's a simple yet versatile product that's a core part of all my workflows!Tim Beiko,Ethereum Foundation Accelerate innovation, foster community, and supercharge collaboration with your go-to Markdown editor. DocsTake no
2018年買ってよかったもの・生活を潤してくれたもの6選［ガジェット・アプリ編］ - はたらく・暮らす・整える
2018年は「攻めの姿勢」と「1ジャンル1アイテムで厳選」のバランスをとりながら、あらたなモノを購入してきました。 そのなかから、より満足度が高くて「買って良かった」を実感した、コストパフォーマンスに優れた商品を6つご紹介します。 まずは、「ガジェット・アプリ編」をご紹介。 2018年買ってよかったもの・生活を潤してくれたもの6選［ガジェット・アプリ編］ Anker PowerCore Fusion 5000 ニンテンドースイッチ Bluetooth折りたたみキーボード「REUDO（リュウド）RBK-3000BT」 完全ワイヤレスイヤホン「Anker Soundcore Liberty Lite」 Markdown対応エディター「Inkdrop」 iClever スマートウォッチ まとめ 2018年買ってよかったもの・生活を潤してくれたもの6選［ガジェット・アプリ編］ Anker Powe
「技術同人誌をMarkdownで書く」とは、実際どういうことか？｜藤原 惟
※ この記事はすべて無料でお読みいただけます。投げ銭歓迎。 ※ またこの記事は「技術同人誌 Advent Calendar 2018」の4日目です。 ※ 12/4 22:34 追記・微修正 以下、技術同人誌を書きたい方・既に書いている方に向けて書いていきます。（Markdown一般の話に比べると、やや高度なことを説明しようとしています。あらかじめご了承ください） ---------------- 技術同人誌という存在を知り、自分でも書きたくなったITエンジニア（特にWeb系）にとって、 「技術同人誌を書くなら、Markdownで書きたい！」 という魂の叫びは当然のことでしょう。 Markdownを使ってブログを書き、簡単な図ならmermeidやPlantUMLで直書きし、プレゼン資料まで作ってしまうMarkdownフリークであれば、「技術同人誌ぐらい、Markdownで書けるはずだ！」とい
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Discover a top-rated GitBook alternative