docs
vale
Our great sponsors
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.
docs
-
Question: Best affordable host to have multiple domains?
I can recommend https://linode.com, their documentation is excellent https://www.linode.com/docs/ and ready made images also https://www.linode.com/docs/marketplace/
- Looking to get into designing and maintaining websites. Do you guys have any course recommendations so I can be knowledgeable about all things websites?
- Ask HN: Classic Self-managed web app hosting resources
-
I want to set up a simple blog page, securely.
>In other words, let the machine do your thinking for you No, this was idiotic. A generator tool like Hugo doesn't "think" for you. it's a tool, used by a thinking person. Even if someone new to HTML publishing happens to adopt Hugo, they are going to learn things. By the sounds of it, it's likely they will learn things you have not. They will still learn about HTML and CSS. They may optionally learn about optimizing their HTML and CSS, if it matters for performance of their finished product. Not all sites are the same, after all. The output of Hugo is static HTML (and CSS, js if used, images and other supporting files). The input of Hugo is also static - a collection of HTML templates, CSS and, usually, Markdown text files as the primary content store. Creatively used, Hugo sites can appear as feature-rich as many database-driven sites and in a manner that you simply could not do armed with only an editor, unless your site is only a handful of pages. Any Hugo site can be configured to generate other representations of the site, too, automatically. You probably think that's nonsense, but then again you probably also do not publish a hand--crafted [Atom](https://spf13.com/index.xml) or RSS feed to go along with your hand-crafted HTML. Hand-crafted does not automatically mean better. Even the simplest Hugo site implementation typically makes use of categories or tags (or both) to help readers find other relevant content. Inserting a new page into an existing hierarchy of categories and/or tags is trivial. Edit a file; tag it. The navigation structure is rebuilt, in milliseconds, whether there are five pages or five hundred. [Steve Francia's site](https://spf13.com/) provides examples of these facets in use. With Hugo you can also produce large documentation sites/subsites, and even more importantly, maintain them. The [Let's Encrypt documentation site](https://letsencrypt.org/docs/) is a textbook case study. It's too bad the `vim` project DOES NOT use a tool like Hugo, because then its documentation would stand a chance of being current instead of: > The [VimDoc project](https://www.vim.org/docs.php) has links to various types of Vim documentation. The online, hyperlinked copy of the documentation is currently outdated. Send in the drones to edit. "Currently" has lasted a long time! Another example: [Linode's documentation site](https://www.linode.com/docs/) is generated by Hugo (according to the meta attribute inside, v0.83). You can see the source code for all their documentation, including the site theme and Hugo specifics, here https://github.com/linode/docs. Shocking, isn't it? A tool being used for productivity! You portray using a productivity tool like Hugo as being somehow lazy. That's ridiculous. It's a powerful tool that happens to scale from the simplest of use cases to the complex, and for every use case, makes it possible to produce far richer sites than is possible completely by hand. And all of that without a database or need for a runtime language on a server, or client. A generated Hugo site has no need for PHP includes or other helpers. It can run on the simplest HTTP server; it's just static content. It's a tool, like an editor is a tool, to make an author more productive.
- Akamai to Acquire Linode
-
SSGs through the ages: The ‘Reinvention’ era
Hugo has seen success with corporate customers, including 1Password, Linode Digital.gov, KeyCDN, and Let’s Encrypt, to name just a few. Bjørn Erik Pedersen took over as the lead maintainer in 2015 and continues to lead Hugo’s thriving community.
-
Markdown Linting
Besides the official Vale style guides Buildkite, Linode, and Write The Docs have rules online that you can copy into your repo or use as inspiration for your own rules.
-
Download all of Linode documentation
- https://github.com/linode/docs
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?
Sculpin - Sculpin — Static Site Generator
proselint - A linter for prose.
markdownlint - A Node.js style checker and lint tool for Markdown/CommonMark files.
lsp-grammarly - lsp-mode ❤️ grammarly
markdownlint - Markdown lint tool
nvim-lspconfig - Quickstart configs for Nvim LSP
Openly - A Vale linter style that aims to replicate Grammarly in an open-source, privacy-friendly way
write-good - Naive linter for English prose
vale-styles - Checks for Vale based on popular style guides
markdownlint - Repository for the markdownlint-mdl-action Github Action
remark-lint - plugins to check (lint) markdown code style