https://github.com/textlint/textlint-app
textlint standalone application top on Electron.
https://github.com/textlint/textlint-app
electron linux mac standalone textlint windows
Last synced: 9 months ago
JSON representation
textlint standalone application top on Electron.
- Host: GitHub
- URL: https://github.com/textlint/textlint-app
- Owner: textlint
- License: mit
- Created: 2017-01-09T11:11:27.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-07-26T22:58:56.000Z (over 7 years ago)
- Last Synced: 2025-05-01T18:55:33.513Z (11 months ago)
- Topics: electron, linux, mac, standalone, textlint, windows
- Language: JavaScript
- Homepage:
- Size: 963 KB
- Stars: 70
- Watchers: 8
- Forks: 6
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# textlint-app [](https://travis-ci.org/textlint/textlint-app) [](https://ci.appveyor.com/project/azu/textlint-app)
[textlint](https://github.com/textlint/textlint "textlint") app for cross platform.
## Why?
- Not require Node.js/npm on your environment.
- Just download binary and launch app.
## Install
Download Binary from
## Features
- No dependencies
- Just install and run it
- Cross platform
- Windows/Linux/Mac - [Download it](https://github.com/textlint/textlint-app/releases/latest)
- Support `.textlintrc`
- You can use existing `.textlintrc` config
- Support `--fix`
- Automatically fix lint error
- TODO:
- [ ] Support only markdown
- [ ] Improve performance
## Usage
1. Open textlint app
2. Go to "Setting" tab
3. Setup `.textlintrc`
- Please see [Configuring textlint](https://github.com/textlint/textlint/blob/master/docs/configuring.md "Configuring textlint")
4. Press "Install"!
5. Edit with textlint
### Example
`.textlintrc`:
```json
{
"rules": {
"no-todo": true
}
}
```
Result:
## Development
You can install textlint-app in local environment.
yarn install
yarn run bootstrap
yarn run watch
yarn run electron
### Update packages
If you update packages/ modules
yarn run publish
# It bump version, not publish to npm
Update packages/ dependencies
yarn upgrade
TODO: `file:` is not linked by lerna... We will improve this.
## Changelog
See [Releases page](https://github.com/textlint/textlint-app/releases).
## Running tests
Install devDependencies and Run `yarn test`:
yarn test
## Contributing
Pull requests and stars are always welcome.
For bugs and feature requests, [please create an issue](https://github.com/textlint/textlint-app/issues).
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## Author
- [github/azu](https://github.com/azu)
- [twitter/azu_re](https://twitter.com/azu_re)
## License
MIT © azu