Redirect Notice You are being redirected to the applicable page at https://docs.asciidoctor.org.
Redirect Notice You are being redirected to the applicable page at https://docs.asciidoctor.org.
Markdown と reStructuredText はどちらもマークアップ言語で、どのテキストエディタを使っても簡単に入力できるように設計されたプレーンテキスト形式構文です。どちらにもマークアップされたテキストをHTMLやPDFなどの出版形式に変換できるツールが多数あります。 これらのマークアップ言語は多くのドキュメンテーションシステムの基礎となるため、昨今のソフトウェア開発者はマークアップ言語をよく知っておく必要があります。この記事ではプログラマ視点でMarkdownとreStructuredTextのトレードオフを分析します。 Markdownが輝きを放つ場所 テキスト入力による豊富な書式設定で複雑なドキュメント構造を記述することができるマークアップ言語は長く輝かしい歴史を持っており、その歴史は少なくとも1970年代初めの troff とTeXまで遡ることができます。 これらの形式
Python Developer’s Guide¶ This guide is a comprehensive resource for contributing to Python – for both new and experienced contributors. It is maintained by the same community that maintains Python. We welcome your contributions to Python! Quick reference¶ Here are the basic steps needed to get set up and contribute a patch. This is meant as a checklist, once you know the basics. For complete inst
Crowiを使っていると文書のバックアップが取りたくなることがあります。 GitlabなどのGithubクローンではWiki機能をgitで管理できたりしますが、Crowiでもバックアップやローカルでの編集ができれば便利ですよね。 そこで、今回はCrowiのAPIを使って記事を編集するツールを作成します。 はじめにスクリプト使い方APIを使ったCrowiの操作記事一覧の取得ダウンロードアップロードはじめにCrowi にはドキュメント化・サポートはされていませんが Web 経由でたたける API があります。そしてエンハンスされたcrowi-plus/Growiでも同じものが使えるようですね。 複雑になるわりに私はあまり使わないので、基本的な本文のアップロード・ダウンロードが出来るようにし、添付やコメントなどの操作は考えないことにします。 一応本家 Crowi だけではなくcrowi-plus
研究じゃなくてこういうことだけ無限にやりたい まえがき 研究室でGrowiというWikiを使ってます. github.com 自動でSlackの特定のチャンネルの投稿内容をWikiにアーカイブすることになったので, その調査をします. 一応ドキュメントは存在しますが, docs.growi.org 手が回っていないようなのでソースを見ます. API捜索 おそらくここにあるものがすべてかと思われます.*1 https://github.com/weseek/growi/blob/master/src/server/routes/index.js API名からあたりをつけます. 今回はページの更新をしたいので https://github.com/weseek/growi/blob/master/src/server/routes/page.js を見れば良さそうです. 仕様調査 ページの更新
はじめに 倶楽部の情報管理に、メルカリが作った社内wiki「Crowi」の派生である、「GROWI」を使用しています。 このCrowiおよびGROWI、通常はページの作成や閲覧はインターネットブラウザを使用して行います。 しかし、実は公式には書かれていませんが、ページの取得や作成といった操作を実行できるAPIが公開されています。 倶楽部の定例会を行う場合、イベントページを作成するのですが、以下の操作がほぼルーチンとなっています。 Templateページを複写してイベントページを作成 ページ名とページ内の日にち情報を、次のイベントの日付に変更 次のテーマやスピーカーを記載 SlackにイベントページのURLと次のイベント日付を含むお知らせメッセージを投稿 これ等の操作を公開APIを使って自動化できないか挑戦してみました。 ※GROWIとして記載しますが、多分Crowiでも同じことができます。
はじめに エンジニアにとって、仕様書などの技術的な文章を書くこと(テクニカルライティングとも言います)は避けて通れません。ただ20年来多くのエンジニアの方々と同僚として接してきて思うことは、エンジニアの方の中には「文章を書く」ということに苦手意識がある方が一定数いるということです。 でもこの「テクニカルライティング」のスキルは、才能というよりは一種の「技能」だと思うんです。ある一定の原理原則を理解して実践を繰り返すことで、必ず一定レベルで習得できるものだと著者は信じています。 もしこのテクニカルライティングの原理原則をまだ体系的に学習したことがない、または過去学習したが改めて再学習したいという方に、お勧めのコンテンツを見つけたのでご紹介します。 https://developers.google.com/tech-writing Every engineer is also a write
こんにちは、今回はデータ基盤構築を担当しているmarushoがお送りします。 今日はestieで実践しているデータベースのドキュメント管理方法をご紹介します。 はじめに 独自成長していくデータベースたち 失われたドキュメント どうすれば低コストなドキュメント管理ができるのか そして生まれた、schema collectorという自動化ツール SchemaSpy Mysql diff Priv Page ECS タスクスケジューラ ドキュメントを腐らせない おわりに はじめに estieはオフィスを中心とした不動産データを取り扱うスタートアップ企業です。 estie(オフィス探しサービス)とestie pro(不動産事業者向けデータプラットフォーム)の2つのサービスを運営しています。 詳しくは、こちらの記事をご覧ください。 inside.estie.co.jp estieでは、不動産に関する
みなさんテストは書いていますよね. 書いていなければふりだしに戻る. 例えば関数 add に対して, 以下のようなテストコードがあるとします. describe("add", () => { it("正しく計算できる", () => { expect(add(1, 2)).toBe(3); }); }); よさそうですね? もしよくないと思うのであればここから下は読まなくても大丈夫なくらい理解している方だと思います. 続いて関数名を変えただけのこちらをどうぞ. describe("sub", () => { it("正しく計算できる", () => { expect(sub(1, 2)).toBe(3); }); }); なんだか明らかに間違っている気がします. もしこのテストが通過してしまったとき我々はどうすればよいのでしょうか. 考えられるパターンは 2 つあります. 実装もテストも正
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く