Zenn をチームで書くための技術
Leaner Technologies の黒曜(@kokuyouwind)です。 Leaner テックブログを Zenn で運用していくにあたり、いくつか技術的に工夫した部分があるので紹介していきます。 チームで Zenn を活用していくための一助になれば幸いです。 記事の slug 命名規約 Zenn では記事の slug をそのままファイル名として articles ディレクトリ配下に配置されます。 このため slug を自由にしてしまうと articles ディレクトリ配下がカオスになり、記事が増えたときに新しい記事を見つけづらくなってしまいます。 そこで slug の先頭に生成日を prefix として生成するよう命名規約を設定しました。[1] とはいえ、記事を書くときにいちいち日付をタイプするのは面倒ですよね。 今回は簡単に命名規約に沿った記事を生成できるよう、 npm-scri
ルールプリセットを使ってお手軽にtextlint入門
textlintはルールで拡張出来る自然言語向けのLintツールです。 textlint 5.1.0でルールのプリセットをサポートしました。 ルール、プリセット、プラグインは以下のような関係です。 rule いわゆるルール rule-preset ルールをまとめたもの plugin ルールとプロセッサ(拡張機能)を持ってる textlintはデフォルトでは一つもルールを持っていません。 そのため、どのルールを入れたらいいか迷った場合に、誰かがまとめてくれたプリセットをとりあえず入れれば、とりあえず文章のチェックが出来るようになります。 textlintの使い方は以下で解説しているのと基本的に同じですが、今回はプリセットの使い方を紹介します。 textlintで日本語の文章をチェックする | Web Scratch インストール textlint本体と2つのプリセットをインストールしてみます
textlintで日本語の文章をチェックする
textlintはMarkdownなどテキスト向けのLintツールで、テキスト版ESLintみたいな感じのツールです。 JavaScriptでルールを書けるテキスト/Markdownの校正ツール textlint を作った | Web Scratch 最近azu/JavaScript-Plugin-Architectureという小さな書籍を書いていて、色々簡単に使えるような仕組みを追加しています。 この記事では簡単なtextlintの導入方法について紹介します。 公式サイトには一部ルールを含むオンラインデモが公開されています。 textlint · The pluggable linting tool for text and markdown ドットインストールにてNode.jsのインストール、textlintの利用方法、エディタとの連携などのチュートリアルが公開されています。Node.
textlintのElectronアプリを作った
textlint-app textlint-appという、インストールするだけで動くtextlintのElectronアプリを作成しました。 インストール方法 https://github.com/textlint/textlint-app/releases/latest からバイナリをダウンロード ダウンロードしたインストーラー（Windows）、app（Mac）を実行すれば動きます。（Node.jsの環境なども不要です） 実行する際に署名されてないバイナリなので警告がでるので、その辺は許可しないと動きません。 Windows: インストーラーで許可を選択する必要がある Mac: /Application/textlint.app をコンテキストメニューから”開く”をして許可する必要がある 特徴 一番の特徴はNode.jsなどの環境を作る必要なくインストールするだけで動く点です。 tex
技術文書を書くためのtextlint校正ルールセット
技術文書向けのtextlintルールプリセットを作りました。 textlint-ja/textlint-rule-preset-ja-technical-writing: 技術文書向けのtextlintルールプリセット 今、書いているjs-primerで使用しています。 元々, JavaScript-Plugin-Architecture: JavaScriptプラグインアーキテクチャの本で実験していたルールをまとめたプリセットになっています。 そのため、実際に適応した状態で書けることは確認した内容がベースです。一部オプションで設定をゆるくしたり、textlint-filter-rule-commentsなどで無視する必要がある部分もありますが、許容範囲な感じでした。 そもそもなんでこういうツールが必要なのかについては以下のスライドを参照してください。 Introduction | 技術文
textlintのルールを簡単に作り始めることができるツールを作りました
textlintはJavaScriptで自由にルールを追加することができる仕組みになっています。 textlintで日本語の文章をチェックする | Web Scratch しかし、普段JavaScriptをあんまり使ってない人にはBabelを使ったコード変換やMochaを使ったテストの設定など、ルールを書き始めるまでの環境づくりの方が大変です。 そのような環境設定をコマンド一発で作れて、textlintルールを作り始めることができるツールを作りました。 create-textlint-rule Scaffolding Tool textlint-scripts BabelやMochaなどのコマンドをラップしたもの 使い方 create-textlint-ruleを npm(Node.jsのパッケージマネージャ)でインストールするだけです。 Node.js(推奨はver6以上)をインストール
書籍執筆でお世話になったツール 〜Re:VIEW, textlint, prh, goemon, GitHub, CircleCI〜 - orangain flavor
「Pythonクローリング&スクレイピング」という書籍を執筆しました。執筆にあたって色々なツール・サービスのお世話になったので、記録を残しておきます。 大まかな流れは、以前の記事に書いたとおりです。ツールの選定は2015年1月頃（textlintとprhは2016年1月頃）に行ったので、現在では状況が変わっているものもあるかもしれません。ご了承ください。 目次 目次 Re:VIEW 採用理由 良いところ 振り返って 作ったものとか textlint 採用理由 良いところ 振り返って 作ったものとか prh 採用理由 良いところ 振り返って goemon 採用理由 良いところ 振り返って GitHub 採用理由 良いところ 振り返って CircleCI 採用理由 良いところ 振り返って まとめ Re:VIEW 原稿の形式は著者の自由とのことでしたので、Re:VIEWで書きました。 Re:VI
textlint + prhで表記ゆれを検出する
proofread-helper proofread-helperは@vvakameさんが作っている文章の校正補助ツールです。(TechBoosterとかの執筆で使っている?らしいです) 機能としては表記ゆれの辞書を指定して、そのルールに則って文章のチェック、また期待する単語への書き換えを行うことができます。 ものすごくざっくり書くと、期待する単語と表記ゆれを補足する正規表現の組み合わせを持った辞書を作ってチェックするような形です。 仕組み的にはazu/technical-word-rulesと殆ど同じですが、辞書をyaml形式で書けたり、辞書内に期待通りに動いているのかの簡単なテストも書くことができます。 なので、辞書の追加や管理がしやすいと思います。 例えば、以下のように辞書を書くことができます。 version: 1 rules: # expectedのみだと 大文字小文字全角半角の
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Introduction | 技術文書をソフトウェア開発する話
textlint/packages/@textlint/markdown-to-ast at master · textlint/textlint
GitHub - 1000ch/linter-textlint: A plugin for Atom Linter providing an interface to textlint.