Giter VIP home page Giter VIP logo

plone-vale's Introduction

Plone Vale

Spelling, grammar, style, and readability linter.

Custom container build for Plone.

docker run -it -v `pwd`:/srv/tests testthedocs/plone-vale

/srv/tests/index.md
1:3   suggestion  'Contributing To The            plone.Titles
                Documentation' should be in
                title case
7:32  suggestion  Don't start a sentence with     plone.So
                'so'
31:4  suggestion  'Edit In The Cloud' should be   plone.Titles
                in title case
33:1  suggestion  Write short sentences (less     plone.SentenceLength
                than 25 words).
36:1  suggestion  Write short sentences (less     plone.SentenceLength
                than 25 words).
71:4  suggestion  'Editing The Docs Using Git'    plone.Titles
                should be in title case

✔ 0 errors, 0 warnings and 6 suggestions in 1 file.

Features

Flexible English language linter with dozens of predefined checks.

Dependencies

Installation

Pull the image:

docker pull testthedocs/plone-vale

Usage

Run ttd-vale from in your docs directory:

docker run -it -v `pwd`:/srv/tests testthedocs/plone-vale

Contribute

Support

If you are having issues, please let us know.

License

MIT

plone-vale's People

Contributors

polyester avatar

Watchers

Chris Chinchilla avatar Sven Strack avatar James Cloos avatar avatar

Forkers

polyester

plone-vale's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.