Skip to content

Vale.sh styles package for Krystal documentation and technical writing.

License

Notifications You must be signed in to change notification settings

krystal/vale-package

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

63 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Krystal Vale Package

This repository contains a Vale-compatible implementation of what we hope to turn into a Krystal style guide.

Getting Started

I have a vale.ini already

To get started, add the package to your configuration file (as shown below) and then run vale sync.

StylesPath = styles # Use your normal style path here.
Packages = https://github.com/krystal/vale-package/releases/latest/download/krystal-vale.zip

Add Vale to a project

Create a .vale.ini at the project's root:

StylesPath = vale-styles  # Location of styles directory
MinAlertLevel = suggestion # Options: suggestion, warning, error
Packages = https://github.com/krystal/vale-package/releases/latest/download/krystal-vale.zip

See Vale's documentation on packages for more information.

About

Vale.sh styles package for Krystal documentation and technical writing.

Resources

License

Stars

Watchers

Forks

Packages

No packages published