Skip to main content

Style checking

One of the features most missed by writers working in docs-as-code is a good spelling, grammar and style checker. By default, spell-checking is provided by your web browser or integrated development environment. This may be adequate for simple websites, but if you need something more advanced then you need a dedicated grammar checker.

LanguageTool​

docStatic is tested with LanguageTool, an AI-based grammar checker that supports over 20 languages. It's free to Signing up for the basic plan. The Premium plan adds style-guide support for individuals and teams. Tailored plans For Business are available. There is also a discount for students and non-profits.

Self hosted​

Because LanguageTool is open-source, you have the option of self hosting (Development). In this case there are no subscription fees, but you will need a development team to set up your LanguageTool instance, and you'll have to provide your own support.

Related topics

  • Prose linting with Vale – Use Vale to enforce a consistent writing style across your docStatic documentation.
  • Using plugins – Extending the functionality of the static site generator with plugins.
  • Chatbot – Add an in-browser AI chatbot that answers questions about your documentation, with no external service required.
  • Hosted CMS – Using docStatic with cloud-hosted or self-hosted TinaCMS.
  • Search engine optimisation (SEO) – How to make your docStatic site maximally search-engine-friendly.
  • Installation – How to install docStatic locally, and start a docStatic site in no time.
  • Search – Search providers.