Skip to content

Commit 6a87954

Browse files
committed
Add more tools & guidelines
1 parent 0a71b08 commit 6a87954

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ This list aims to assist by providing you with out-of-box templates and practica
2828
- [Site Builder](#site-builder)
2929
- [Wiki Builder](#wiki-builder)
3030
- [Knowledge Base Builder](#knowledge-base-builder)
31-
- [Text Checker](#text-checker)
31+
- [Checker \& Formatter](#checker--formatter)
3232
- [Diagramming Tool](#diagramming-tool)
3333
- [Multimedia Tool](#multimedia-tool)
3434
- [More Topics](#more-topics)
@@ -284,12 +284,17 @@ API is the univesal language of the software world, which needs to be documented
284284
- [MrDoc](https://github.com/zmister2016/MrDoc) - An online document system suitable for individuals and small teams to manage documents, wiki, knowledge and notes.
285285
- [AFFiNE](https://github.com/toeverything/AFFiNE) - A next-gen knowledge base that brings planning, sorting and creating all together.
286286

287-
### Text Checker
287+
### Checker & Formatter
288288

289289
- [LanguageTool](https://github.com/languagetool-org/languagetool) - Style and Grammar Checker for 25+ Languages.
290290
- [Spellcheck GitHub Actions](https://github.com/rojopolis/spellcheck-github-actions) - A GitHub Action that spell checks Python, Markdown, and Text files.
291291
- [TeXtidote](https://github.com/sylvainhalle/textidote) - A correction tool for LaTeX documents and other formats.
292292
- [alex](https://github.com/get-alex/alex) - Catch insensitive, inconsiderate writing.
293+
- [Lychee](https://github.com/lycheeverse/lychee) - Finds broken URLs and mail addresses inside Markdown, HTML, reStructuredText, websites and more.
294+
- [linkinator](https://github.com/JustinBeckwith/linkinator) - A super simple site crawler and broken link checker.
295+
- [Readability checker](https://www.thewriter.com/tools/readability) - Score your writing based on the Flesch reading ease scale, which looks at how long your words and sentences are.
296+
- [Capitalize My Title](https://capitalizemytitle.com/) - An easy, smart title capitalization tool that uses title capitalization rules published by leading professional organizations to ensure your titles and headlines are capitalized correctly.
297+
- [CasePolice](https://github.com/antfu/case-police) - Scan all your source files and fix the cases of known names.
293298

294299
### Diagramming Tool
295300

@@ -318,9 +323,14 @@ Documentation can be more than just plain texts and static pictures.
318323

319324
### Guidelines
320325

326+
- [Style Guides](https://www.writethedocs.org/guide/writing/style-guides/) - Collections of style guides from Write the Docs community.
321327
- [Google developer documentation style guide](https://developers.google.com/style/highlights) - Provides editorial guidelines for writing clear and consistent Google-related developer documentation.
322328
- [Microsoft Writing Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/) - If you write about computer technology, this guide is for you.
329+
- [Editorial guidelines for Apple](https://support.apple.com/guide/applestyleguide/welcome/web) - Provides guidelines to help maintain a consistent voice in Apple materials, including documentation.
330+
- [GitHub Docs Style guide](https://docs.github.com/en/contributing/style-guide-and-content-model/style-guide) - Make sure GitHub's documentation stays consistent and follows clear patterns that our readers can understand.
331+
- [Red Hat Technical Writing Style Guide](https://stylepedia.net/style/) - Includes everyday punctuation and grammar, common mistakes to avoid, strategies for translation and global audiences, and a word usage dictionary.
323332
- [Series: Writing Great Documentation](https://jacobian.org/series/great-documentation/) - A series of articles laying out the tools, tips, and techniques author learned over the years he've spent helping to write Django's docs.
333+
- [Command Line Interface Guidelines](https://clig.dev/) - An open-source guide covering CLI help text and documentation.
324334

325335
### Examples
326336

0 commit comments

Comments
 (0)