{"id":19884554,"url":"https://github.com/zzkt/smog","last_synced_at":"2025-05-02T15:31:05.745Z","repository":{"id":49821879,"uuid":"238558404","full_name":"zzkt/smog","owner":"zzkt","description":"Analyse the writing style, word use and readability of prose in Emacs. ","archived":false,"fork":false,"pushed_at":"2023-05-30T08:43:52.000Z","size":69,"stargazers_count":28,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"endless","last_synced_at":"2025-04-07T03:05:15.360Z","etag":null,"topics":["automated-readability-index","automated-readability-scores","coleman-liau","emacs","flesch-kincaid","fog-index","gunning-fog","language","prose","readability","readability-metrics","smog","smog-grading","style","writing-analytics"],"latest_commit_sha":null,"homepage":null,"language":"Emacs Lisp","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zzkt.png","metadata":{"files":{"readme":"README.org","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":"2020-02-05T22:08:37.000Z","updated_at":"2024-05-24T16:43:12.000Z","dependencies_parsed_at":"2024-11-12T17:32:37.476Z","dependency_job_id":"64ac5582-0140-43cc-a6af-15a8a83189e3","html_url":"https://github.com/zzkt/smog","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zzkt%2Fsmog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zzkt%2Fsmog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zzkt%2Fsmog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zzkt%2Fsmog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zzkt","download_url":"https://codeload.github.com/zzkt/smog/tar.gz/refs/heads/endless","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252062756,"owners_count":21688595,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["automated-readability-index","automated-readability-scores","coleman-liau","emacs","flesch-kincaid","fog-index","gunning-fog","language","prose","readability","readability-metrics","smog","smog-grading","style","writing-analytics"],"created_at":"2024-11-12T17:27:53.969Z","updated_at":"2025-05-02T15:31:05.734Z","avatar_url":"https://github.com/zzkt.png","language":"Emacs Lisp","readme":"\n** Style \u0026 readability\n\n[[https://melpa.org/#/smog][file:https://melpa.org/packages/smog-badge.svg]]\n\nA simple way to analyse the writing style, word use and readability of prose in Emacs.\n\nIt can be used by calling =smog-check-buffer= or =smog-check-region= on the selected region.\n\nThe analysis is produced via the command line tool =style=. It performs several [[https://en.wikipedia.org/wiki/Readability][readability]] tests on the text including; [[https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests][Flesch-Kincaid readability tests]], [[https://en.wikipedia.org/wiki/Automated_readability_index][Automated Readability Index]] (aka “ARI”), [[https://en.wikipedia.org/wiki/Coleman%E2%80%93Liau_index][Coleman-Liau Index]], [[https://en.wikipedia.org/wiki/Gunning_fog_index][Gunning fog index]] (aka \"Fog Index\"), and [[https://en.wikipedia.org/wiki/SMOG][SMOG Index]] (aka \"SMOG-Grading\", “Simple Measure Of Gobbledygook“). It also summarises word usage and provides information about sentence and paragraph structure. The output is presented as a summary, so if you are looking for more specific, or continuous feedback on style and/or grammar then using =flycheck= with [[http://proselint.com/][proselint]] might be more suitable.\n\n** Install\n\nThe textual analysis requires [[http://wiki.christophchamp.com/index.php?title=Style_and_Diction][style]] to be installed. The tools =style= and =diction= are part of the GNU project and should be available for most unix-like systems.\n\nTo install on Debian\n#+BEGIN_SRC bash\napt install diction\n#+END_SRC\n\nTo install on macOS\n#+BEGIN_SRC bash\nbrew install style\n#+END_SRC\n\nTo install from source, download from http://ftp.gnu.org/gnu/diction/\n\n** Configure\n\nThe emacs package can be installed from [[https://melpa.org/][MELPA]] or manually via [[https://github.com/zzkt/smog][github]].\n\n#+BEGIN_SRC emacs-lisp\n(use-package smog)\n#+END_SRC\n\nTo configure language or output options, =setq= or customize the =smog-command= variable.\n\nThe default language is set to =en= (English) and can be changed to =de= for German or =nl= for Dutch. Details for the various output options can be found via =style -h= or =man style= in your shell of choice.\n\n#+BEGIN_SRC emacs-lisp\n(use-package smog\n :config (setq smog-command \"style -L en\"))\n#+END_SRC\n\ne.g. to analyse a text in German and show sentences longer than 23 words…\n\n#+BEGIN_SRC emacs-lisp\n(use-package smog\n :config (setq smog-command \"style -L de -l 23\"))\n#+END_SRC\n\n** Analyse surface detail\n\n=M-x smog-check=\n\n** Further\n  - [[https://wiki.christophchamp.com/index.php?title=Style_and_Diction][style]] is written by Michael Haardt with contributions from Jason Petrone, Uschi Stegemeier and Hans Lodder\n  - [[https://files.eric.ed.gov/fulltext/ED506404.pdf][The Classic Readability Studies]]. William H.DuBay, Editor\n  - [[https://en.wikipedia.org/wiki/Asemic_writing][Asemic writing]]\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzzkt%2Fsmog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzzkt%2Fsmog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzzkt%2Fsmog/lists"}