redocusaurus
vale
redocusaurus | vale | |
---|---|---|
4 | 46 | |
571 | 4,187 | |
- | 1.2% | |
7.3 | 9.3 | |
19 days ago | 4 days ago | |
TypeScript | Go | |
MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
redocusaurus
-
Gitbook to Readme.io conversion regret
I'm also curious which OpenAPI plugin u/teranym is using—I've personally been using redocusaurus (and like it a lot), and tried docusaurus-openapi for a bit (not bad, some glitches), but I'd love to learn more about what else is out there and how people are using it!
-
6 ways we improved our documentation in 2022
The website was previously built with Gatsby using a custom theme. As part of the refactor, we changed it to run as part of our Docusaurus main documentation and on top of Redocly using the Redocusaurus plugin.
-
Brick by brick: why Docusaurus is a powerful documentation framework
Great examples of this can be found on their community plugins page, where others have built plugins for offline/local search (we even use this today), adding SASS styles loading, and consuming OpenAPI specs to generate full API documentation pages. And it couldn’t be easier to roll your own.
-
How to create documentation like Stripe?
- https://github.com/rohit-gohri/redocusaurus
vale
- Software Technical Writing: A Guidebook [pdf]
- Grammarly editor writing service are malfunctioning
- Vale.sh – A Linter for Prose
- Ask HN: Best tool to proof-read technical documentation?
- Val, a high-level systems programming language
-
Common Bugs in Writing
Vale is an OSS tool that you can use as a "prose linter" with many of these rules. You can also write your own rules. Together with a spellchecker its a good replacement for proprietary tools like grammarly.
- https://github.com/errata-ai/vale
-
Just Simply – Stop saying how simple things are in our docs
> Write in US English with US grammar. (Tested in British.yml.)
heh, that was funny but it turns out the file is a list of British words checked using Vale, which I just learned existed: https://github.com/errata-ai/vale#readme (MIT)
Also, another TIL is that the "e" version of gray is British https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale... I had previously erroneously assumed they were just one of those quirks of English (which, I guess is still true but it is less random than I thought)
-
Tools that enforce/promote corporate standards?
Off the top of my head, Vale and Acrolinx.
-
Over 60% of Writers Already Use AI in Their Writing Workflow
I have recently thought of feeding the suggestions from Vale (https://vale.sh/) into an LLM along with your writing. Currently I just simply ask an LLM to take what I wrote and put it into a more "active voice". I then manually edit my writing to make it more "active" if I choose -- I do not just publish LLM generated content unaltered.
Note: I did not ask an LLM for this comment.
-
What terminal apps are you using?
vale to spell check and enforce writing style on my articles
What are some alternatives?
Docusaurus - Easy to maintain open source documentation websites.
proselint - A linter for prose.
docusaurus-openapi-docs - 🦝 OpenAPI plugin for generating API reference docs in Docusaurus v2.
lsp-grammarly - lsp-mode ❤️ grammarly
PolyGlot - PolyGlot is a conlang construction toolkit.
nvim-lspconfig - Quickstart configs for Nvim LSP
remark-admonitions - Add admonitions support to Remarkable
write-good - Naive linter for English prose
rehype-cloudinary-docusaurus - Cloudinary offers an image CDN which can improve performance of your site. This plugin allows Docusaurus to use Cloudinary to serve optimised images.
markdownlint - Repository for the markdownlint-mdl-action Github Action
docusaurus-json-schema-plugin - JSON Schema viewer / editor in Docusaurus
remark-lint - plugins to check (lint) markdown code style