https://github.com/eclipse-che/che-docs-vale-style
Vale style for Eclipse Che Documentation and related projects
https://github.com/eclipse-che/che-docs-vale-style
eclipse-che vale vale-style
Last synced: 10 months ago
JSON representation
Vale style for Eclipse Che Documentation and related projects
- Host: GitHub
- URL: https://github.com/eclipse-che/che-docs-vale-style
- Owner: eclipse-che
- License: epl-2.0
- Created: 2022-01-20T18:53:16.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-06-01T08:32:33.000Z (about 3 years ago)
- Last Synced: 2025-06-04T00:47:55.520Z (12 months ago)
- Topics: eclipse-che, vale, vale-style
- Language: HTML
- Homepage:
- Size: 50.8 KB
- Stars: 1
- Watchers: 23
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.adoc
- Contributing: CONTRIBUTING.adoc
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
:toc:
# Vale style for Eclipse Che documentation and blog
This repository hosts the _CheDocs_ Vale style.
This style has additional rules to the link:https://vale.sh/hub/redhat/[_RedHat_ Vale style], intended for:
* link:https://github.com/eclipse-che/che-docs/[Eclipse Che documentation Git repository]
* link:https://github.com/eclipse-che/blog/[Eclipse Che blog Git repository]
== Adding the _CheDocs_ Vale style to your project
.Procedure
. Reference the _CheDocs_ Vale package in your Vale configuration file:
+
.`.vale.ini`
[source,ini]
----
StylesPath = .github/styles
MinAlertLevel = suggestion
Packages = RedHat, https://github.com/eclipse-che/che-docs-vale-style/releases/latest/download/CheDocs.zip
[*.adoc]
BasedOnStyles = RedHat, CheDocs
----
. Synchronize your Vale packages:
+
[source,commandline]
----
$ vale sync
----
. Run vale on your files:
+
[source,commandline]
----
$ vale .
----
.Additional resources
* Consider adopting and adapting our link:https://github.com/eclipse-che/che-docs-vale-style/blob/main/.vale.ini[Vale configuration file].
* Consider adopting the link:https://github.com/errata-ai/vale-action[GitHub Action for Vale].