Asciidocで仕様書の「開発環境」を整える (1) - Qiita
概要 モダンな仕様書の「開発環境」を構築した。 結果として、以下のような雛形の環境が出来上がった。 モチベーション システム系のお仕事では、多かれ少なかれ仕様書を書かなければいけない。また、この仕様書を共有したり、管理したりしなくてはいけない。長年、WordやExcelで書いて、ネットワークフォルダで共有・管理するとしていたが、次のようなツラさを感じたことはないだろうか。 複数人で分担して書いた後、マージする作業がつらい。マージをミスって肝心な部分が入っていない。 記載内容のレビューを任されたが、どこが変更点かわからない。しょうがないから、適当にスルーする。 後から見返すと日本語としてめちゃくちゃ。これが原因で誤解を生み、後々問題になる。 フォルダやファイル名に頼ったバージョン管理をする。が、徐々に形骸化して必要な時に意味を成していない。 ソフトウェア開発、特にコーディングの世界では、昔か
技術書を書く技術 - Qiita
Intro こちらの技術書を執筆しました。15Stepで踏破 自然言語処理アプリケーション開発入門 本稿は書籍そのものの紹介ではなく、私が技術書を執筆するために利用した技術・用意した環境についての解説です。 私が執筆を始めた当時（2017年下旬）はWebを漁ってもあまり技術書執筆のノウハウがなく、本稿の内容も割と手探りでした。今ググってみると技術書展のおかげで大量に情報が出てきますね。それらと被る部分もありそうですが、自分が１冊書いてみて得たノウハウみたいなものをここに吐き出してみたいと思います。 執筆フォーマットの決定 まずは執筆に使うツールを決めます。 商業誌の場合、出版社（編集者）がそのフォーマットでの入稿を受け付けてくれるかどうかにも依るため、執筆者の一存で決められないこともあるようです。 私の場合は幸運にも、こちらの希望に合わせてくれる編集者が入ってくれました。 色々調べて↓あた
Insert automatically generated table of contents TOC on rendered markdown files like README.md. · Issue #215 · isaacs/github
Edit March 2021: GitHub now added a workaround mentioned at: #215 (comment) That is a good step, but I'll keep this open until they actually add a way to add it inside the rendered output (which can be e.g. searched more easily with Ctrl+F). When I see a manually generated table of contents, it makes me sad. When I see a huge README that is impossible to navigate without it, it makes me even sadde
textlintでAsciidoc/Asciidoctorをサポートするプラグイン
textlintでAsciiDoc/Asciidoctorを限定的にサポートするプラグインを書きました。 textlint-plugin-asciidoc-loose 制限 今のところParagarphとStrしかサポートしていません。 他のNodeは単純に無視されるので、HeaderやList、Linkなどはないものと同じ扱いになっています。 簡単にいうと本文の文章をチェックするルールしか上手く動かないという感じです。 textlintのルールの大体は本文を対象としているので、Collection of textlint ruleに書かれてるルールの8割ぐらいは動くような気がします。 HeaderやListのサポートぐらいできたら結構良さそうな気がするので、Pull Request募集中です。 Issues · azu/textlint-plugin-asciidoc-loose 現状は
AsciiDoc（Asciidoctor）の文書をtextlintで校正する - 詩と創作・思索のひろば
AsciiDocはMarkdownのようなテキストマークアップ言語のひとつで、ページ内リンクや脚注などかなり機能が豊富なので、大きめのドキュメントを本腰を入れて書くなど、表現したいものがある程度複雑なときに便利。DocBookというフォーマットを通じて、HTMLだけでなくPDFとかroff形式にも変換できるらしい（やったことはない）。GitのドキュメントがAsciiDoc形式で書かれているのを見て知って、自分も個人的なドキュメントはREADME.adocなどとして、AsciiDoc形式で書くことがある。AsciidoctorはAsciiDocの実装のひとつで、Rubyで書かれていて利用が簡単なのでこれを使っている。 さて、上記の記事でtextlintなるものを知ったので、AsciidoctorのJavaScript実装を使ってプラグインを書こうと思いたったわけだ（標準で対応しているのはプレ
Buy Instagram Followers - Real, Cheap and Active Users
Answering the Question: “How Can I Get More Followers on Instagram?” the Straightforward Way Why Instagram and why you absolutely need to buy Instagram followers as quickly as you possibly can You’re probably wondering why I recommend that you jump aboard Instagram over all of the other social media networks that you could purchase followers four – especially Facebook and Twitter in particular. Th
Promise本で取り組んだ電子書籍の開発ツール、CI、継続的リリースについて
Promise本の取り組み JavaScript Promiseの本の開発で取り組んだ事と取り組んでおくべき(考慮しておくべき)だったことについてのメモ書き 技術書のディレクトリ構成とか参考になるものがあんまりなくて適当に作ったので、その辺を整理をしたい目的で書いてます。 はじめに ここで書いたPromise本のディレクトリ構成やCI、テスト手法、使ったツールなどについては以下に大体書いてあります。 JavaScript Promiseの本 付録 上記の付録のソース : promises-book/Appendix-Note at master · azu/promises-book promises-book/CONTRIBUTING.md at master · azu/promises-book なので、結構省いて書いてるのでちゃんと見たい人は付録とかの方を見て下さい。 後、書籍の文
テクニカルライティングの将来 ー GitHub上のAsciidocで技術書Pro Gitを協働執筆 | POSTD
Pro Git第2版の驚くべき冒険と最終的なツールチェーン ほぼ6年前、私はApressから執筆が予定より遅れていたPro Gitと呼ばれる本の手伝いの誘いを受けました。結局原著者が書き続けないことを決めて、私が最初から書き直して2009年8月頃に最終的に出版されました。最初の3章あたりは、私はWordで本を書きました。そして編集者に文書を送って、しばらくして最終的な版を手にしました。 この3章のあとで、私たちが執筆と技術的な編集段階のためにMarkdownに切り替えて、同意された編集のためにだけWordへ戻るように提案したとき、私はやめようとしていました。一旦本が完成したら、私はすべての内容をMarkdownへ再び戻したので、それを私が作成したWebサイトにおいてオンラインで発表できました。幸運にも、原著者は著作をクリエイティブ・コモンズ・ライセンスとすることでApressと同意しました
asciidoctor-fopubで生成するPDFのヘッダとフッタをカスタマイズする - Qiita
はじめに asciidoctor-fopubで生成されるPDFの"Table of Contents"などを日本語化する - Qiitaをさらに発展させて、各ページのヘッダとフッタをカスタマイズしてみました。 ここでは例としてヘッダに会社のロゴ画像、フッタにコピーライト表示を追加します。 サンプルPDFとスクリーンショット サンプルPDF: http://1pac.github.io/asciidoctor_template/embed_image_sample.pdf サンプルレポジトリ: https://github.com/1pac/asciidoctor_template ヘッダのスクリーンショット フッタのスクリーンショット 変更内容の説明 asciidoctor/asciidoctor-fopubに含まれいているsrc/dist/docbook-xsl/フォルダをコピーして修正
JavaScript Promiseの本Ver1.2とAsciidoctor
Promise本 以前JavaScript Promiseの本を書きました | Web Scratchでも書いていましたが、 電子版である意味は常に書籍が更新できるという点が大きいです。 そのため、JavaScript Promiseの本 も semverな感じでアップデートしていっています。 どのような変更があったかはGitHub Releaseにかかれているのでそちらを参考にして下さい。(RSSで購読も出来ます) Releases · azu/promises-book 現在Promise本はver1.2ですが、1.0.0…1.2.0では以下のような変更が主なところです。 1.0.1 (2014-06-23) “金を払えないという重大なバグ“を修正 (7909005) 1.1.0 (2014-06-25) コラム: Promiseは常に非同期? への加筆 column-promise-
Asciidoctor 1.5.0 “Bleeding Heart” released! | Asciidoctor
The long-awaited release of Asciidoctor 1.5.0 “Bleeding Heart” has arrived at last! This release includes a stockpile of 150 fixes, improvements and enhancements as well as several refinements to the AsciiDoc syntax. We’re confident you’re going to love writing with Asciidoctor more than ever before. Asciidoctor 1.5.0 is the sequel to 0.1.4. We shifted the numbers to adopt a semantic versioning sc
Asciidoc-Bootstrap
Features Since the version 1 Fixed Navbar is always pinned at top of the output file (even if empty). Brand is configurable. Dynamic Navbar control which navigation information files will be included in the output file. Dynamic Footer control which footer information file will be included in the output file. TOC position can be place on a sidebar on left or right of the main document. Themes suppo
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
AsciiDoc Working Group | The Eclipse Foundation
GitHub - asciidocfx/AsciidocFX: Asciidoc Editor and Toolchain written with JavaFX 21 (Build PDF, Epub, Mobi and HTML books, documents and slides)
GitHub - opendevise/asciidoc-samples: A repository of AsciiDoc source files for testing AsciiDoc rendering on GitHub.
GitHub - opendevise/textlint-plugin-asciidoc: An AsciiDoc processor for use with textlint.
https://github.com/electron/electron/blob/master/docs/tutorial/testing-on-headless-ci.md
Amazon.co.jp: ドキュメント作成システム構築ガイド[GitHub、RedPen、Asciidoctor、CIによる モダンライティング]: 伊藤敬彦 (著), 吉村孝広 (著), 208 (その他): 本![Amazon.co.jp: ドキュメント作成システム構築ガイド[GitHub、RedPen、Asciidoctor、CIによる モダンライティング]: 伊藤敬彦 (著), 吉村孝広 (著), 208 (その他): 本](https://cdn-ak-scissors.b.st-hatena.com/image/square/b3e159842a1f96e7a6cd3ad60234c73b55fc521d/height=288;version=1;width=512/https%3A%2F%2Fm.media-amazon.com%2Fimages%2FI%2F516v0w26krL._SL500_.jpg)
Eloquent JavaScript's Build System
JavaScript Promiseの本
