-
-
Notifications
You must be signed in to change notification settings - Fork 4
/
index.html
62 lines (54 loc) · 10.5 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
<!DOCTYPE html><html lang=""><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>textlint · The pluggable linting tool for text and markdown</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="The pluggable linting tool for text and markdown"/><meta property="og:title" content="textlint · The pluggable linting tool for text and markdown"/><meta property="og:type" content="website"/><meta property="og:url" content="https://textlint.github.io/index.html"/><meta property="og:description" content="The pluggable linting tool for text and markdown"/><meta property="og:image" content="https://textlint.github.io/img/textlint-icon_256x256.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://textlint.github.io/img/textlint-icon_256x256.png"/><link rel="shortcut icon" href="/img/textlint-icon_256x256.png"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://textlint.github.io/blog/atom.xml" title="textlint Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://textlint.github.io/blog/feed.xml" title="textlint Blog RSS Feed"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/textlint-icon_256x256.png" alt="textlint"/><h2 class="headerTitleWithLogo">textlint</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/getting-started.html" target="_self">Docs</a></li><li class=""><a href="https://github.com/textlint/textlint/wiki/Collection-of-textlint-rule" target="_self">Rules</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li><li class=""><a href="/help.html" target="_self">Help</a></li><li class=""><a href="https://github.com/textlint/textlint" target="_self">GitHub</a></li><li class="navSearchWrapper reactNavSearchWrapper"><input type="text" id="search_input_react" placeholder="Search" title="Search"/></li></ul></nav></div></header></div></div><div class="navPusher"><div class="main"><script>document.body.classList.add("is-index");</script><script src="/js/index.js"></script><div class="homeContainer"><div class="homeSplashFade"><div class="wrapper homeWrapper"><div class="inner"><h2 class="ProjectTitle">textlint<small class="ProjectTitle-copy">The pluggable linting tool for text and markdown</small></h2><div class="section promoSection"><div class="promoRow"><div class="pluginRowBlock"><a class="GettingStartedButton" href="/docs/getting-started.html">Getting Started</a></div></div></div></div></div></div></div><div class="mainContainer"><div class="container paddingBottom paddingTop"><div class="wrapper"><div class="productShowcaseSection paddingBottom TextlintFeature"><div><span><p><strong>textlint</strong> is an open source text linting utility written in JavaScript.
It is hard to lint natural language texts, but we try to resolve this issue by <strong>pluggable</strong> approach.</p>
</span></div></div><div class="gridBlock"><div class="blockElement TextlintFeature-gridBlock alignCenter imageAlignTop threeByGridBlock"><div class="blockImage"><img src="/img/icon-pen.svg"/></div><div class="blockContent"><h2><div><span><p>Rules</p>
</span></div></h2><div><span><p>To use a rule, simply run npm install textlint-rule-xxx.
See the <a href="https://github.com/textlint/textlint/wiki/Collection-of-textlint-rule">collection of textlint rules</a>.</p>
</span></div></div></div><div class="blockElement TextlintFeature-gridBlock alignCenter imageAlignTop threeByGridBlock"><div class="blockImage"><img src="/img/icon-markdown.svg"/></div><div class="blockContent"><h2><div><span><p>Markdown & Texts</p>
</span></div></h2><div><span><p>Markdown and plain text are supported by default.
HTML and other formats are offered by custom plugins</p>
</span></div></div></div><div class="blockElement TextlintFeature-gridBlock alignCenter imageAlignTop threeByGridBlock"><div class="blockImage"><img src="/img/icon-formatters.svg"/></div><div class="blockContent"><h2><div><span><p>Custom Formatters</p>
</span></div></h2><div><span><p>Formatter is used both by bundled and custom formatters</p>
</span></div></div></div></div></div></div><div class="GettingStarted productShowcaseSection"><div class="container"><div class="wrapper"><h2 id="getting-started" class="GettingStarted-title">Getting Started</h2><p class="GettingStarted-copy">You can use textlint by following steps:<br/>For more details, see <a href="/docs/getting-started.html">documents</a>.</p><div class="getStartedFlexContainer" style="display:flex;flex-flow:row;align-items:flex-start;justify-content:space-between"><div class="GettingStarted-steps"><ol><li>Create your project:<div class="getStartedStep"><div><span><pre><code class="hljs css language-bash">npm init --yes
</code></pre>
</span></div></div></li><li>Install textlint into your project:<div class="getStartedStep"><div><span><pre><code class="hljs css language-bash">npm install --save-dev textlint
</code></pre>
</span></div></div></li><li>Install textlint rule:<div class="getStartedStep"><div><span><pre><code class="hljs css language-bash">npm install --save-dev textlint-rule-no-todo
</code></pre>
</span></div></div></li><li>Create .textlintrc file:<div class="getStartedStep"><div><span><pre><code class="hljs css language-bash">npx textlint --init
</code></pre>
</span></div></div></li><li>Run textlint:<div class="getStartedStep"><div><span><pre><code class="hljs css language-bash">npx textlint README.md
</code></pre>
</span></div></div></li></ol></div><div class="GettingStarted-images"><ol><li><img src="/img/get-started-steps/1.png" alt="$ npm init --yes
Wrote to ~/textlint-demo/package.json:
{
"name": "textlint-demo",
"version": "1.0.0"
}"/></li><li><img src="/img/get-started-steps/2.png" alt="$ npm install --save-dev textlint
+ textlint@10.0.0
added 239 packages in 10.23s"/></li><li><img src="/img/get-started-steps/3.png" alt="
$ npm install --save-dev textlint-rule-no-todo
+ textlint@latest
added 239 packages in 10.23s"/></li><li><img src="/img/get-started-steps/4.png" alt="$ npx textlint --init
Create .textlintrc"/></li><li><img src="/img/get-started-steps/5.png" alt="$npx textlint README.md
~/textlint-demo/README.md
1:3 error Found TODO: '- [ ] Write usage' no-todo
✖ 1 problem (1 error, 0 warnings)
"/></li></ol></div></div></div></div></div><div class="container"><div class="wrapper"><div class="productShowcaseSection paddingBottom paddingTop Playground"><h2 id="try" class="Playground-title">Playground</h2><p class="Playground-copy">Take textlint for a spin, start typing below.<br/>Want to try more? Go to <a href="https://textlint.github.io/playground">playground</a>.</p></div><iframe class="Playground-frame" sandbox="allow-scripts" src="https://textlint.github.io/playground?embed" title="online demo" width="100%" height="500"><p>Your browser does not support iframes. Please visit <a href="https://textlint.github.io/playground">online demo</a>.</p></iframe></div></div><div class="container paddingTop"><div class="wrapper"><div class="productShowcaseSection paddingBottom paddingTop Showcase"><h2 class="Showcase-title">Who's Using This?</h2><p>This project is used by all these people. <a href="/users.html">More textlint users</a>.</p></div><div class="productShowcaseSection paddingBottom"><div class="logos"><a href="https://jsprimer.net"><img src="https://78.media.tumblr.com/avatar_c63524fcb991_128.png" title="JavaScript Primer"/></a><a href="https://github.com/vuejs/jp.vuejs.org"><img src="https://avatars3.githubusercontent.com/u/6128107?s=200&v=4" title="jp.vuejs.org"/></a><a href="https://survivejs.com/webpack/"><img src="https://www.gravatar.com/avatar/b26ec3c2769168c2cbc64cc3df9cdd9c?s=200" title="SURVIVEJS - WEBPACK"/></a><a href="http://hood.ie/"><img src="https://hoodiehq.github.io/hoodie-css/src/content_img/animals/low-profile-dog-3.png" title="Hoodie"/></a><a href="https://github.com/gis-oer/gis-oer"><img src="https://raw.githubusercontent.com/gis-oer/gis-oer/master/img/logo/logo_gis-oer_01_256px.png" title="GIS実習オープン教材"/></a><a href="https://soracom.jp"><img src="/img/soracom.png" title="株式会社ソラコム"/></a><a href="https://kohsei-san.hata6502.com/lp/"><img src="https://kohsei-san.hata6502.com/favicon.png" title="校正さん"/></a></div></div></div></div></div></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/textlint-icon_256x256.png" alt="textlint" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/configuring.html">User Manual</a><a href="/docs/rule.html">Developer Guide</a></div><div><h5>Community</h5><a href="https://gitter.im/textlint-ja/textlint-ja">Project Chat</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/textlint/textlint">GitHub</a><a class="github-button" href="https://github.com/textlint/textlint" data-icon="octicon-star" data-count-href="/textlint/textlint/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2024 textlint organization</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
document.addEventListener('keyup', function(e) {
if (e.target !== document.body) {
return;
}
// keyCode for '/' (slash)
if (e.keyCode === 191) {
const search = document.getElementById('search_input_react');
search && search.focus();
}
});
</script><script>
var search = docsearch({
apiKey: '27ef1d5fc0d12142485f3784f7d3cb46',
indexName: 'textlint',
inputSelector: '#search_input_react',
algoliaOptions: {}
});
</script></body></html>