{"id":31816632,"url":"https://github.com/splunk/vale-splunk-style-guide","last_synced_at":"2026-02-18T10:03:47.004Z","repository":{"id":63193101,"uuid":"537085186","full_name":"splunk/vale-splunk-style-guide","owner":"splunk","description":"Splunk Style Guide for the Vale linter","archived":false,"fork":false,"pushed_at":"2024-08-19T21:58:53.000Z","size":287,"stargazers_count":20,"open_issues_count":0,"forks_count":10,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-10-11T09:57:32.377Z","etag":null,"topics":["splunk","vale-linter-style"],"latest_commit_sha":null,"homepage":"https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Howtouse","language":null,"has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/splunk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-09-15T15:15:19.000Z","updated_at":"2025-08-27T15:23:43.000Z","dependencies_parsed_at":"2023-11-30T18:31:16.227Z","dependency_job_id":"b0c61f41-4c88-48ff-bfa4-28e0ddaf6d30","html_url":"https://github.com/splunk/vale-splunk-style-guide","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"purl":"pkg:github/splunk/vale-splunk-style-guide","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splunk%2Fvale-splunk-style-guide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splunk%2Fvale-splunk-style-guide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splunk%2Fvale-splunk-style-guide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splunk%2Fvale-splunk-style-guide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/splunk","download_url":"https://codeload.github.com/splunk/vale-splunk-style-guide/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splunk%2Fvale-splunk-style-guide/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29575343,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-18T08:38:15.585Z","status":"ssl_error","status_checked_at":"2026-02-18T08:38:14.917Z","response_time":162,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["splunk","vale-linter-style"],"created_at":"2025-10-11T09:57:18.955Z","updated_at":"2026-02-18T10:03:46.992Z","avatar_url":"https://github.com/splunk.png","language":null,"readme":"[Vale](https://github.com/errata-ai/vale) is an open source prose linter that can check the content of documents in several formats against style guide rules. The goal of a prose linter is automating style guide checks in docs-as-code environments, so that style issues are detected before deploy or while editing documentation in a code editor. This repo contains a set of linting rules for Vale based on the [Splunk Style Guide](https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Howtouse).\n\n# Get started\n\n1. Clone the repository.\n2. Install Vale with `brew install vale` or similar commands. See [Installation](https://vale.sh/docs/vale-cli/installation/).\n3. (Optional) Install the [Vale add-on for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=errata-ai.vale-server).\n4. (Optional) Set `vale.core.useCLI` to `true` in the extension settings.\n5. Run `vale .` from the root folder of the repo, or save/edit a file using Visual Studio Code.\n\nFor more information, see [Scoping](https://vale.sh/docs/topics/scoping/).\n\n# Folder structure\n\n- `.vale.ini` contains the Vale settings. See [Configuration](https://vale.sh/docs/topics/config/).\n- `styles/Splunk` contains the Splunk rules for Vale. See [Styles](https://vale.sh/docs/topics/styles/).\n\n# Use as a git submodule\n\nTo use the contents of this repository as a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules), run the following git commands from the target repo:\n\n```bash\ngit submodule add git@github.com:splunk/vale-splunk-style-guide.git\ngit submodule update --init --recursive\ngit commit -m \"Added the Vale submodule to the project.\"\ngit push\n```\n\nCopy the sample `.vale.ini` file to the root of your repository, and change the path to point to the submodule:\n\n```ini\nStylesPath = vale/styles\n```\n\nTo update the submodule, run the following git command from the root folder of the repository:\n\n```\ngit submodule update --remote --merge\n```\n\n# Resources\n\n- [Vale's official documentation](https://vale.sh/docs/vale-cli/overview/)\n- [Regex101, a web-based regular expressions editor](https://regex101.com/)\n\n# License\n\nThis software is licensed under the Apache License 2.0. Details can be found in the file LICENSE.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsplunk%2Fvale-splunk-style-guide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsplunk%2Fvale-splunk-style-guide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsplunk%2Fvale-splunk-style-guide/lists"}