- Notifications
You must be signed in to change notification settings - Fork0
textlint-ja/technological-book-corpus-ja
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
日本語技術書のコーパス。
日本語の再配布が可能な技術書を集めたものです。商用利用できないライセンスを含みます。
主にMarkdownで書かれた技術書を集めたものです。
- 日本語の技術文書
- 特殊なDSL(Markdownの拡張など)を行っていない文書
- ある程度の量がある文書
- 再配布が可能なライセンスである文書
条件に含んでいないもの
- 校正が十分に行われているかどうか(校正済みの文書を収集するものではない)
- textlintルールのテストのfixtureとして利用する
- 文書は逐次更新されるため、自動テストには適していません
例) コーパスに含まれている文章に対してtextlintでチェックして意図しない結果がないかを確かめる
npm install --global textlint technological-book-corpus-ja# --rule でルール名を指定するtechnological-book-corpus-ja| xargs textlint --rule textlint-no-todo -f pretty-error
開発中のルールをコーパスでテストする方法。
--prefix tmp/で一時的なディレクトリにインストールして確認する。
mkdir tmp/npm install --save-dev textlint-rule-preset-ja-technical-writing textlint technological-book-corpus-ja --prefix tmp/cd tmp# --rule でルール名を指定する./node_modules/.bin/technological-book-corpus-ja| xargs ./node_modules/.bin/textlint --rule textlint-rule-my-rule -f pretty-error --no-textlintrc
Install withnpm:
npm install technological-book-corpus-ja$ npm i -g technological-book-corpus-ja$ technological-book-corpus-ja/Users/technological-book-corpus-jasource/js-primer/array/README.md/Users/technological-book-corpus-ja/source/js-primer/comments/README.md/Users/technological-book-corpus-ja/source/js-primer/condition/README.md/Users/technological-book-corpus-ja/source/js-primer/data-type/README.md/Users/technological-book-corpus-ja/source/js-primer/function-method/README.md/Users/technological-book-corpus-ja/source/js-primer/implicit-coercion/README.md/Users/technological-book-corpus-ja/source/js-primer/introduction/README.md/Users/technological-book-corpus-ja/source/js-primer/loop/README.md/Users/technological-book-corpus-ja/source/js-primer/object/README.md/Users/technological-book-corpus-ja/source/js-primer/operator/README.md/Users/technological-book-corpus-ja/source/js-primer/read-eval-print/README.md/Users/technological-book-corpus-ja/source/js-primer/README.md/Users/technological-book-corpus-ja/source/js-primer/statement-expression/README.md/Users/technological-book-corpus-ja/source/js-primer/string/README.md/Users/technological-book-corpus-ja/source/js-primer/variables/README.mdパターンでの絞り込みもできます。
$ technological-book-corpus-ja "/**/js-primer/**/*.md"constReferences={"JavaScript-Plugin-Architecture":{name:"JavaScript-Plugin-Architecture",url:"https://github.com/azu/JavaScript-Plugin-Architecture",license:"https://github.com/azu/JavaScript-Plugin-Architecture#license"},"Introduction-to-Add-on-Development-in-Blender":{name:"Introduction-to-Add-on-Development-in-Blender",url:"https://github.com/nutti/Introduction-to-Add-on-Development-in-Blender",license:"https://github.com/nutti/Introduction-to-Add-on-Development-in-Blender/blob/draft/LICENSE"}, ...};/** * get files by glob pattern *@param {string} patterns glob pattern * "/" root is source directory *@see https://github.com/isaacs/node-glob */module.exports.findByPattern=functionfindByPattern(patterns){};/** * get files by type * default all files *@param {string} ext * e.g) ".md" */module.exports.get=functionget(ext=".*"){};
このコーパスは次の文書を含んでいます。それぞれの文書のライセンスに基づき再配布されています。
- js-primer
- License: CC BY-NChttps://github.com/asciidwango/js-primer/blob/master/LICENSE
- JavaScript-Plugin-Architecture
- License: CC BY-NChttps://github.com/azu/JavaScript-Plugin-Architecture#license
- Introduction-to-Addon-Development-in-Blender-Web
- The-Little-Book-on-CoffeeScript
- progit
- License: CC BY-NC-SA 3.0https://git-scm.com/book/en/v2
- what-is-maven
- License: CC BY-NC 4.0https://github.com/KengoTODA/what-is-maven/blob/main/preface/README.md
- Hatena-Textbook
- License: CC BY-NC-SA 2.0https://github.com/hatena/Hatena-Textbook#%E3%83%A9%E3%82%A4%E3%82%BB%E3%83%B3%E3%82%B9
- build-web-application-with-golang
- License: BSD 3-Clausehttps://github.com/astaxie/build-web-application-with-golang/blob/master/LICENSE.md
- Go-SCP-jaJP
git submodule add <追加するGit URL> repo/<name>index.jsのReferencesに定義を追加するbuild.jsのcopyTaskに文書のみをコピーする処理を追加する
次のコマンドでsubmoduleを更新できる。
npm run update-refs
文書の構造が変わっていないかを確認し、build.jsを修正する
SeeReleases page.
Install devDependencies and Runnpm test:
npm i -d && npm testPull requests and stars are always welcome.
For bugs and feature requests,please create an issue.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :D
MIT © azu
About
日本語で書かれた技術書を収集した生コーパス/ツール
Topics
Resources
License
Code of conduct
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
No packages published
Uh oh!
There was an error while loading.Please reload this page.
Contributors2
Uh oh!
There was an error while loading.Please reload this page.