Getting Started with Vale part 3 Using Vale with 3rd party style guides and custom rules

Sdílet
Vložit
  • čas přidán 6. 09. 2022
  • Vale can be used with 3rd-party Style Guides and Custom rules to lint prose. 3rd-party Style guides like Google, Microsoft, and Joblint, just to mention a few, can be applied as per the user’s preference. Custom rules can enforce personal styles to prose; for example, heading formats or how to write certain technical words in prose. Vale enforces your organization’s writing standards and rules despite who the writer is.
    TIMESTAMPS
    01:00 Part 1 and part 2 Recap
    01:43 Using Vale and Google Style Guide
    04:22 Install and configure Vale Extension in VSCode
    09:05 Using Vale with Custom Rules
    Need help writing your docs? Reach out to us for a consultation - calendly.com/plburton/documen...
    Notes and Code Samples: artisanal-pioneer-1249.ck.pag...
  • Věda a technologie

Komentáře • 6

  • @porshb
    @porshb Před rokem +1

    Thanks for this. Didn't know you can create custom rules.

  • @rampage241
    @rampage241 Před rokem

    Vale is such an awesome tool!

    • @documentwrites
      @documentwrites  Před rokem

      We agree. Vale is a great way to automate the tedious parts of using a style guide. We use a linter for our code, why not implement one for our docs?

  • @ShirlyPunk
    @ShirlyPunk Před rokem +1

    FYI: You don't have to change the User *and* the Workspace settings. That's redundant. User settings act as a kind of 'global' set of settings, and Workspace settings are like overrides that supersede the User settings when working in that specific folder/directory.

    • @documentwrites
      @documentwrites  Před rokem

      Hi Paul, thanks for sharing the tip. I did only put the settings under User settings initially, but for some reason it did not work on my computer. It was only after duplicating the same under workspace settings that it worked for me, Thanks for watching!