タグ検索の該当結果が少ないため、タイトル検索結果を表示しています。
私のチームで行っているドキュメント管理方法の紹介(GitHub Actions, S3, AsciiDoc) | DevelopersIO
ドキュメントツールのインストール(Windows) Macの場合の設定方法は、本項の後に記載 PowerShellの起動 各種ツールをインストールするため、PowerShellを管理者として実行 Windowsボタンを押下 powershell と入力 右クリックで管理者として実行 を選択します Chocolateyのインストール 本手順は前述で起動したPowerShellを利用 1.Chocolatey のサイトにアクセスし、インストールコマンドをクリップボードへコピー 2.前項でコピーしたコマンドをPowerShellにペーストして実行します Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServiceP
AsciiDocを利用してエンジニアのナレッジを上手に集約しよう | cloud.config Tech Blog
はじめに 流用性・検索性が高いドキュメントの作成は今後のエンジニアに求められるスキルの一つです。 一方で社内ではPowerPointやWordによるドキュメント作成が頻繁に行われる事が多いのではないでしょうか？PowerPointやWordは即時性が高いフォーマットですが、流用性・検索性を確保し続ける事が困難です。 エンジニアが気軽に出版レベルのドキュメントを作成したり、Wikiより管理の容易なナレッジを作成するのに役立つAsciiDocをご紹介するとともに、より柔軟な運用について提案したいと思います。 目次 AsciiDocとはAsciiDocの記述方法AsciiDocを利用すべき理由社内ドキュメントとの共存編集中のAsciiDocをプレビューするにはAsciiDocでHTMLやPDF等を出力するにはAsciiDocとは AsciiDocは軽量マークアップ言語の一つで可読文書記述形式です
技術書、ブログ、READMEを書いてていて、文章中に出てくるコードブロックのコードをテストしたいことがあると思います。 そのサンプルコードが本当に動いてるのか不安になることがあるからです。 power-doctestは、そのコードブロック中のコードにコメントを入れるだけでテスト可能にするツール群です。 power-doctestの例 具体的な例から見ていきます。 次の例では、Markdownで説明とJavaScriptのコードブロックを書いています。 デフォルト引数を使って書くことで、このような挙動は起きなくなるため安全です。 デフォルト引数では、引数が渡されなかった場合のみデフォルト値が入ります。 ```js function addPrefix(text, prefix = "デフォルト:") { return prefix + text; } // falsyな値を渡してもデフォルト
GitHub PagesのSourceにGitHub Actions(beta)を指定し、AsciiDocとSwaggerUIを公開する構成 | DevelopersIO
※ リポジトリのページから「Settings」->「Source」設定確認可能 Source指定にDeploy From a branchと比較し、GitHub Actions(beta)を利用するメリットには以下があります。 ホスティングのために用意しているブランチやビルド成果物が不要になり、認知負荷を下げられる ビルド資材をコミットする作業がなくなる ビルド資材の容量が大きい場合、pullやcheckoutにかかる時間を削減できる(モノレポの場合コードに対するCIにも影響する) 設定方法 前提 今回は以下をホスティングする想定にします。 Swagger UI AsciiDoc with PlantUML 何らかのHTTP REST APIの仕様書を作る想定です。 リポジトリテンプレート リポジトリテンプレートは公開しています。用途に応じてカスタマイズして頂けたらと思います。 ファイル/
はじめに 流用性・検索性が高いドキュメントの作成は今後のエンジニアに求められるスキルの一つです。 一方で社内ではPowerPointやWordによるドキュメント作成が頻繁に行われる事が多いのではないでしょうか？PowerPointやWordは即時性が高いフォーマットですが、流用性・検索性を確保し続ける事が困難です。 エンジニアが気軽に出版レベルのドキュメントを作成したり、Wikiより管理の容易なナレッジを作成するのに役立つAsciiDocをご紹介するとともに、より柔軟な運用について提案したいと思います。 AsciiDocとは AsciiDocは軽量マークアップ言語の一つで可読文書記述形式です。 出力もHTML, PDF, ePubなどが行えるため個人での出版活動から開発環境でのナレッジの共有まで様々な用途で利用する事が可能です。 AsciiDocの記述方法 軽量マークアップ言語でメジャーな
こんにちは、デジタルペンテスト部のねいちゃーどです。 普段は チート対策ペネトレーションテストサービス の診断員として、主にゲームに関わるサービスの脆弱性診断を担当しています。 私たちのチームでは、お引き受けさせていただいた案件に対する成果物として「報告書」を作成・提出しています。 報告書には「発見した脆弱性についての詳細なレポート」などが記載されています。 端的に還元すれば「報告書を作成するのが本業」と言っても過言ではありません。 その報告書の作成には以前まで Microsoft Word (以下、Word) を用いていました。 しかし Word を用いた報告書作成には、以下の問題がありました。 共同編集機能を用いた際に、編集内容が競合することがある その結果、同ファイルをリネームして上げ直さないといけなくなったり、代表者がローカルに落として編集した事例が過去にあった 「【最新版】打ち合
某方に布教されてAsciiDocにめっちゃハマった。 AsciiDocって markdownのような軽量マークアップ言語の一種。 markdownより優れている点 markdownより高機能。 困ったらHTMLタグ直書きとかしなくていい。 表セルを結合出来る。 ソースコード、PlantUMLなどをincludeできる。 目次が自動で作られる。 使用可能なアイコンが大量にある。 PDF書き出しした時の見た目が安定&綺麗。 (plantUMLについては過去記事参照) ai-gaminglife.hatenablog.com markdownに劣る点 環境構築がダルい 普及してない はてなブログがasciidocに対応していない 環境構築 windowsを想定。macでも大体変わらない（と思う）。 ruby installerをDLし、実行環境を整える asciidoctorとエクステンションを
マニュアルや操作説明書など、改版を繰り返す文書や、共同で執筆する文書などは、バージョン管理システムにより、最新版や改版履歴の管理が必要です。 Wordなどで作成されることが多いと思いますが、バージョン管理システムとの親和性やテキストデータの流用性、検索性に優れた軽量マークアップ言語の AsciiDoc を紹介します。 ここで紹介する AsciiDoc は、PDF形式の出力を前提に、Asciidoctor, Asciidoctor-pdf について説明します。 この文書も、AsciiDocで記述し、Git(バージョン管理システム)で修正履歴を管理しています。
Asciidoc でブログを書きたい
はてなブログでは、記事を Markdown にて書いていたのですが、最近自分の中で Asciidoc が熱く、 ブログ記事も Asciidoc で書きたいなという思いが高まり、 勢い余ってブログを移行することにしました。
本記事はQiita Advent Calendar "ドキュメンテーション Advent Calendar 2021" 12/15(水)分の記事になります。 はじめに Twitterで活動をご覧の方や、今年の別なAdvent Calendarをご覧になった方はご存知かと思いますが、 今年の5月、ちょっと縁があって本を書いたんですよ。 最初に本を書いたのはZenn上だったんですが、その後で欲が出てきて色々なメディアに展開しようとした際、色々と手間が発生し、試行錯誤をそこそこたくさんこなした結果、何やら良さげな環境ができまして。 Advent Calendarにかこつけて共有してみたくなったので、この記事を書きました。 電子書籍の複数メディア展開 今私が記事や本をアップロードしている、このZennではmarkdownで電子書籍を書くことになります。 この書籍をAmazon Kindle向けに提
Windows上のVisual Studio Codeで、AsciiDocのプレビュー環境の構築 - シナプス技術者ブログ
シナプスの技術部 システム開発課の蔵坪と申します。 弊社は、10年近くソースコードは、Subversionで管理しておりましたが、昨年、GitLabに移行しました。 弊社でお世話になっているパートナーさんから、GitLabはAsciiDocが利用できるので、仕様書などのドキュメントは、AsciiDocがお勧めだとアドバイスをもらいました。そこで、Windows上のVisual Studio CodeでAsciiDocのプレビューできる環境を構築してみました。 AsciiDocとは AsciiDocとは、メモ、ドキュメンテーション、記事、本、電子ブック、スライドショー、Webページ、マニュアルページ、ブログを書くためのテキスト文書フォーマットです。 試した環境 OS : Windows 10 Professional (1809) AsciiDocのプレビューに必要なツール Chocolat
I've been using Markdown for a long time, and have grown accustomed to it. It has various quirks, features, and oddities, but what doesn't. But recently I decided to take a look at Asciidoc, a Markdown "competetor". I found it a great little document toolchain, but it won't replace Markdown. Both Asciidoc and Markdown allow you to write text based content using a simplified markup syntax. Instead
GitHub Actionsを使って気軽にAsciiDocを出力しよう(1) | cloud.config Tech Blog
はじめに AsciiDocを利用したいけど環境構築は面倒くさい。 エンジニアが気軽に出版レベルのドキュメントを作成したりWikiより管理の容易なナレッジを作成するのに役立つAsciiDoc。 その面倒な環境構築をほとんど抜きにしてGitHubでホスティングするだけでHTML作成まで自動化する方法を紹介します。 AsciiDocについて AsciiDocについては前回の記事にて紹介させていただきました。こちらの記事をご参照いただけると嬉しいです。 AsciiDocを利用してエンジニアのナレッジを上手に集約しようGitHub Actionsとは GitHub Actionsはコードを保存するリポジトリと同じ場所でソフトウェア開発のワークフローを自動化する機能です。 従来からCI/CD環境をJenkins等で構築されている方も多いかと思いますが、小規模な開発では構築の負担が大きかったり、複数の環
AsciiDoc - Wikipedia
AsciiDocは軽量マークアップ言語のひとつである。意味論的にはDocBook XMLと同一であるが、対人可読な文書記述形式であり、文書の（論理）構造を意味付ける規則が平文形式である。ゆえに構文解析器を介することなく、テキストエディタなどを用いてAsciiDocで記述された文書を作成・閲読できる。HTMLを始めPDF、manページ、電子書籍、スライドといった種々の形式[6]にDocBookツールチェーンを介して変換することが可能である。 歴史[編集] AsciiDocは2002年、Stuart Rackhamによって構想された。彼はPythonで書かれた平文つまり対人可読なファイルを、通常の出版に用いられる形式に変換する翻訳機を公表した[6]。 2013年、「Asciidoctor」と呼ばれるAsciiDoc翻訳機のRubyによる実装がGitHubにおいて発表された[7]。Asciido
脱Word, Excel仕様書、Markdown, asciidocで書いたHTML仕様書でイキイキ - Qiita
経緯 Word, Excelで仕様書を作ることが多いが、結構ストレスがたまる。。。 差分が分からない プルリクエストが使えない 複数人で編集しづらい そこで軽量マークアップ言語のMarkdown, asciidocで作成し、HTML化することでいろんなメリットがあるので紹介します。 Markdown, asciidocとは？ wiki形式で記述し、HTMLなどに変換 他にもtextile, reStructuredTextなど 例(asciidoc) メリット一覧 変更の差分が簡単に分かる Word, Excelで差分を表すときは色を変えるなどの方法があるが面倒＆戻すのも面倒 Githubなどで管理できるが、差分は分からないので、 ただのファイル置き場 Wordには「変更履歴の記録」機能があるが、 記録の開始を忘れると悲惨 Markdown, asciidocはテキスト形式なので、Gith
Antora で AsciiDoc 形式のドキュメントが保存されたレポジトリからドキュメントサイトを生成してみる - かんがるーさんの日記
Translate to English https://translate.google.com/translate?sl=auto&tl=en&u=https%3A%2F%2Fksby.hatenablog.com%2Fentry%2F2021%2F01%2F21%2F101651 概要 記事一覧はこちらです。 AsciiDoctor は AsciiDoc 形式のドキュメントから HTML ファイル等を作成するためのツールですが、Antora は AsciiDoc 形式のドキュメントが保存されたマルチレポジトリからファイルを取得してドキュメントサイトを生成するためのツールとのこと。TOC を作るだけでなく HTML ファイルを含めてサイト全体を作ってくれるらしい。 AsciiDoctor を使った方がよいのか Antora を使った方がよいのか少し悩みましたが、よく見ると開発している人
Asciidocで技術文章を作成する - Qiita
はじめに Asciidocは、Markdownとほとんど同じような記述法でお手軽にかけて、規模の大きい文章を書くことにも適しています。 例えば、Pro Gitは、日本語版PDFで500ページを超えるGitの解説書ですがAsciidocで書かれています。 ソフトウェアの設計書など、そこそこの規模になる技術文章を記述するのにAsciidocが良いと思い導入してみました。 参考にしたページの紹介と、実際に使ってみて、感じた利点などを紹介します。 参考 以下のリンクのComparison by exampleにMarkdownの記法と比較して、どう書くかが記載されているので参考になります。 AsciiDoc vs Markdown, asciidoctor docs 少し分量が多いですが、日本語化されたリファレンスもあります。 Asciidoctor 文法クイックリファレンス(日本語訳) とりあえ
9/6 メモ吐き出し。 3行まとめ Docker on WSL2はいいぞ なぜAsciidocを使うのか Asciidoc文章の所感 Asciidoc スライドの所感 Asciidoc を使う Asciidocのイメージをインストール Revealjsのプレゼン資料を作る Gitlab CIと連携して静的なページを作成する。 まとめ 3行まとめ WSL2上で動かすDockerはいいぞ Windowsだと設定が面倒なAsciidocも簡単に使えるぞ ということです。 Docker on WSL2はいいぞ 自前の環境を汚さずになにか作業したい場合，Dockerは非常に便利なツールです。 WSL1やDOSネィティブの環境でDockerを使おうとした場合，従来はHyper-Vが必要（Windows Homeでは無理）だったのですが，WSL2のUbuntu環境を立てることで，Ubuntu上でaptか
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
MarkdownやAsciidoc中に書いたJavaScriptのサンプルコードをdoctestするツールを作った
エンジニアのドキュメント作成に適した「AsciiDoc」とは？
AsciiDoc で「イイ感じ」な文書を作る - ラック・セキュリティごった煮ブログ
AsciiDoc + VSCodeでかっこいい文書作る - Gaming Life
AsciiDoc文書作成入門:: Asciidocによる文書作成環境の構築 [AFFRIT Portal]
Asciidoc centricな(Zenn含む)複数メディア向け電子書籍作成環境
I wish Asciidoc was more popular • pdx.su
WSL2上のDockerを用いてAsciidocの文書，スライドを書く - 粗大メモ置き場
www.youtube.com
news.yahoo.co.jp
togetter.com
jp.ign.com
ml.asahi.com
tunagate.com