Quartoで技術書を写経すると楽しい｜igjit
ソースコードはこちら。 コードの写経に今回はじめてQuartoを使ったのですが、これが快適だったので紹介します。 Quartoとは公式ページには、QuartoはPandocを基にした技術文書の出版システムです、とあります。 Markdownでコード混じりの文書を書いたら、コードブロックの中身を自動で実行してくれて、結果をHTMLとかPDFとかプレゼンスライドとかに書き出してくれるやつです。 https://quarto.org/Rユーザーにとっては次世代のR Markdownとのことです。 はじめかたhttps://quarto.org/docs/get-started/ のとおり、Quarto CLIツールをインストールします。 DockerでR、RStudioを動かす場合、最近のイメージならQuartoはインストール済みです。(rocker/tidyverse:4.2.1 で確認) Q
技術文書の書き方
howto-tech-docs.md 技術文書の書き方 このメモは、私（@ymmt2005）が長年にわたってソフトウェアプロダクト開発に関わってきて 2022年現在こうしたほうが良いと考えているベストプラクティスです。 科学的な分析等に基づくわけではない経験則であるため、今後も随時見直すことがありますし、 ここに書いてあることが常に正しいわけでもあらゆるソフトウェア開発に適するわけでもありません。 しかしながら、実務経験が豊富で、モダンな技術スタックに明るいエンジニアの経験則は一定の 役に立つのではないかと考えて記します。 技術文書とは ここでは、ソフトウェア開発で技術者が書くべき文書ということにします。 ソフトウェアエンジニアにも役割がいろいろあり、アーキテクトと independent contributor では書く文書が違うということはあるでしょうけれど、ここではごっちゃにします。
仕様起因の脆弱性を防ぐ！開発者向けセキュリティチェックシート(Markdown)を公開しました - Flatt Security Blog
はじめに こんにちは。株式会社Flatt Securityセキュリティエンジニアの村上 @0x003f です。 これまで弊社ブログでは様々な「仕様とセキュリティ観点の解説記事」を発表してきました。今回はいままでの記事を改めて紹介しつつ、読者の皆様が開発中のサービスでセルフチェックを行えるよう「仕様とセキュリティ観点チェックリスト」を作成しました。ご活用いただけると幸いです。 ダウンロードは下記のGitHubリンクよりどうぞ。 また、株式会社Flatt Securityではお客様のプロダクトに脆弱性がないか専門のセキュリティエンジニアが調査するセキュリティ診断サービスを提供しています。料金に関する資料を配布中ですので、ご興味のある方は是非ご覧ください。 はじめに アプリケーションの仕様起因の脆弱性とは アプリケーションの仕様起因の脆弱性を防ぐために 仕様の脆弱性によく見られる共通点 1. ク
テックブログの校正を支える技術 textlint とルール設定について｜Offers Tech Blog
Offers を運営している株式会社 overflow の あほむ です。「〜を支える技術」的な技術評論社さまの伝統的パンチラインに感化されてしまう世代です。 文書校正の自動化でおなじみの textlint textlint は JSer.info や JavaScript Primer でおなじみの azuさん が開発されている OSS です。 ESLint に代表される各種 Lint ツールの自然言語バージョンです。プレーンテキストや Markdown テキストを対象にいわゆる文章校正を自動的に走らせて、ルールによっては自動修正も適用できます。 弊社のテックブログは GitHub リポジトリで zenn のコンテンツを管理 しており、そのリポジトリ上で textlint を使ってルールに従った文章校正の自動化を試みています。 GitHub Actions の設定 設定はシンプルで Pu
74thの技術同人誌執筆環境（Markdown+Vivliostyle+VS Code）
これは Visual Studio Code Advent Calendar 2021 の19日目の記事です。 技術記事や、技術書を書くことが多数あります。技術書典11では、以下を執筆していました。 今も技術書典12に向けて、執筆を続けています。ここで使っているツールセットを紹介したいと思います。 CSS組版 Vivliostyle で Markdown をPDFにする HTML&CSSで組版ができる Vivliostyle を使っています。 Vivliostyle は CLI ツールが提供されており、これを使うことで、執筆環境を簡単に整えたり、1コマンドでPDFをビルドできたりします。 執筆環境を整えるには、Create Bookを使います。 以下のコマンドでビルドするための環境が整います。 このコマンドでできた環境では、npmに付属するタスクランナーでビルドコマンドが組まれています。そ
VSCode + Markdownでスライドや書籍も書いちゃおう！ - Qiita
はじめに Markdownって便利ですよね？ README.md、PR や Issue の本文やコメント、Qiita や Zenn はもちろん、Google Docs や Trello や Notion や Jupyter Notebook でも使えるみたいです。もっといろいろな文書を Markdown で書ければいいのになあ、あらゆる文書のソースコードを Markdown にできればいいのになあ。 さあ、Markdown の可能性を広げましょう！ 本記事では「スライド」と「(電子)書籍」をMarkdownで書く方法をご紹介したいと思います。もちろん、VSCodeでMarkdownを効率よく便利に書いていくためのチップスもご紹介していきますよ。 ご参考スライド VS Code Conference Japan 2021 で発表した際の以下スライドもご参照ください。 もちろんこのスライドもV
自己流の手順書フォーマットを公開してみた | DevelopersIO
手順書フォーマットは千差万別 みなさんは自己流または、組織やプロジェクトで定められた手順書のフォーマットはありますか? 私は自己流の手順書フォーマットがあります。 自己流の手順書フォーマットがあるといっても、かなり扱いがふわふわしているので、備忘やメモの意味合い強めでまとめていきます。 「もっとこうした方がいいよ!!」などフィードバックがあれば、ぜひお願いします! いきなりまとめ 手順書はExcelやスプレッドシートではなく、Markdownで書く 手順書はgitで管理する 5W1Hを意識して手順書を書く 基本的にはCLIを使った手順書にする 手順書はExcelやスプレッドシートではなく、Markdownで書く 手順書をExcelやスプレッドシートで書くメリット・デメリット 手順書をExcelやスプレッドシートで書いている方も多いと思いますが、私はMarkdownで書いています。 Exce
Markdownファイル校正手順 - 実務編 - Qiita
npm のちょっとしたオプションについては以下を参照。 Step.1 本体と最低限のルールをインストール 任意のフォルダを作成。 C:\workspaces\textlint_work cd C:\workspaces\textlint_work npm init -y npm install --save-dev textlint textlint-rule-preset-ja-spacing textlint-rule-preset-ja-technical-writing 上記で、textlint 本体 + プリセット2つをインストールする。 preset-ja-spacing preset-ja-technical-writing npx textlint --init で、.textlintrc が生成される。 Step.2 追加のルールをインストール 上を参考に入れてみる。 n
Swimlanes.io
Create sequence diagrams with simple online tool Swimlanes.io is a free webapp for making sequence diagrams. You simply edit the text on the left and the diagram is updated in real time. You can download your sequence diagrams as images or distribute with a link. title: Welcome to swimlanes.io One -> Two: Message note: **swimlanes.io** is a simple online tool for creating _sequence diagrams_. Edit
Markmap - Visual Studio Marketplace
markmap-vscode This extension integrates markmap into VSCode. Features Preview markdown files as markmap Edit markdown files in a text editor and the markmap will update on the fly Works offline Usage Command Palette Open a markdown file. Then open the Command Palette (⇧⌘P) and search Open as markmap, press enter. Context menu Right click on a markdown file, then choose Open as markmap. Button on
ドキュメント作成ツールの決定版！Markdown + React の体験を Docusaurus で
What is Docusaurus ? Build optimized websites quickly, focus on your content - Docusaurus Keytar Docusaurus とは "最適化されたウェブサイトを迅速に構築し，本質に集中させる" というスローガンのもと Facebook 傘下のチームが開発している 静的サイトジェネレータです．特徴として，次の五つが挙げられています． Powered by Markdown => MDX Built Using React Content Search Ready for Translations Document Versioning ※ただし，まだまだアルファなので４，５については工事が進行中 追記：2021 年 5 月 12 日に β 版がリリースされ，2022/02/23 現在では beta.15
novelWriter
A markdown-like editor for novels A markdown-like text editor designed for writing novels and larger projects of many smaller plain text documents. It is designed to be a simple text editor that allows for easy organisation of text files and notes, with a meta data syntax for comments, synopsis, and cross-referencing between files, and built on plain text files for robustness.
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-
Markdownベースのプレゼンテーション・エディタ「Slideas for Mac」が、次期アップデートで「reveal.js」フレームワークをサポートしHTML形式での書き出しが可能に。
Markdownベースのプレゼンテーション・エディタ「Slideas for Mac」が、次期アップデートでプレゼンテーション・フレームワーク「reveal.js」のテーマと、HTMLエクスポートをサポートするそうです。詳細は以下から。 SlideasはフランスのAgaric Perdereauさんが開発しているMac用のプレゼンテーション・エディタで、Markdown記法でプレゼンテーションを作成できますが、このSlideasが次期v1.2アップデートでHTMLプレゼンテーション・フレームワーク「reveal.js」をサポートするそうです。 I also had multiple requests for a simple Slide Template. I then decided to port some of the Reveal.js themes to Slideas.[…]T
「Markdown+CSS/TeXで冊子本を作ってみた」に参加してみた - 自己顕示欲の開放治療所
「Markdown+CSS/TeXで冊子本を作ってみた」に参加してみた connpass.com 2019/11/16 訂正 訂正いただきました箇所、打ち消し線と + 記号で大体わかるように、なっているといいな、しました。 開始前 記事中のAmazonのリンクはアフィリエイトにしていますので嫌悪感を抱かれる方は気をつけてください。 アンテナハウス株式会社*1様主催のセミナーに参加してきました。以前『PDFインフラストラクチャ構造解説』のPOD（Print On Demand）本を買ったときに存在を知り、ウェブサイトの「XMLに命をかけてくれ」というエピソード紹介が印象に残っていました。大規模、構造的ドキュメント用のソフトウェアに強みのある会社という理解です。 PDFインフラストラクチャ解説: 電子の紙PDFとその周辺技術を語り尽す 作者: 小林徳滋出版社/メーカー: アンテナハウスCAS電
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GitHub - VikParuchuri/marker: Convert PDF to markdown quickly with high accuracy
Notes
GitHub - 1xyz/pryrite: Pryrite, interactively execute shell code blocks in a markdown file
脱ExcelしたいMarkdownテンプレート目次 - Qiita
GitHub - docuowl/docuowl: 🦉 A documentation generator
