{"id":18496241,"url":"https://github.com/oddbird/sassdoc-theme-herman","last_synced_at":"2025-04-12T14:57:33.371Z","repository":{"id":44772439,"uuid":"46441325","full_name":"oddbird/sassdoc-theme-herman","owner":"oddbird","description":"An Odd SassDoc theme.","archived":false,"fork":false,"pushed_at":"2025-04-01T18:25:41.000Z","size":345634,"stargazers_count":118,"open_issues_count":38,"forks_count":11,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-04-12T14:57:28.455Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://oddbird.net/herman/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oddbird.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","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},"funding":{"github":"oddbird","open_collective":"oddbird-open-source"}},"created_at":"2015-11-18T19:13:56.000Z","updated_at":"2025-04-01T18:25:43.000Z","dependencies_parsed_at":"2023-02-19T10:30:38.742Z","dependency_job_id":"df144a52-1710-4fa3-b0eb-d834d71e6abf","html_url":"https://github.com/oddbird/sassdoc-theme-herman","commit_stats":{"total_commits":956,"total_committers":15,"mean_commits":"63.733333333333334","dds":0.4372384937238494,"last_synced_commit":"911ccdaaf1f5cb6a15ae733ede3d6002c7d6b01e"},"previous_names":[],"tags_count":63,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oddbird%2Fsassdoc-theme-herman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oddbird%2Fsassdoc-theme-herman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oddbird%2Fsassdoc-theme-herman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oddbird%2Fsassdoc-theme-herman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oddbird","download_url":"https://codeload.github.com/oddbird/sassdoc-theme-herman/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248586250,"owners_count":21128997,"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":[],"created_at":"2024-11-06T13:28:33.933Z","updated_at":"2025-04-12T14:57:33.348Z","avatar_url":"https://github.com/oddbird.png","language":"JavaScript","funding_links":["https://github.com/sponsors/oddbird","https://opencollective.com/oddbird-open-source"],"categories":[],"sub_categories":[],"readme":"# [Herman][herman] [a [SassDoc][sassdoc] theme]\n\n[![Build Status](https://github.com/oddbird/sassdoc-theme-herman/actions/workflows/test.yml/badge.svg)](https://github.com/oddbird/sassdoc-theme-herman/actions/workflows/test.yml)\n\n\u003e **If it's not documented, it doesn't exist.**\n\u003e Documentation should become the default --\n\u003e an integrated part of the development process.\n\u003e\n\u003e \u003ccite\u003e---\u003ca href=\"https://www.oddbird.net/authors/miriam/\"\u003eMiriam Suzanne\u003c/a\u003e\u003c/cite\u003e\n\nAt [OddBird][oddbird],\nwe wanted better tools for documenting\nthe entire front end of a project --\nfrom brand guidelines to UX patterns and code APIs:\n\n- Documenting the intersection of languages and styles\n- Written directly in the code,\n  and integrated with code architecture\n- Automated for a document that grows and changes\n  along with the life of your project\n\nHerman is built as an extension to [SassDoc][sassdoc],\nand supports all their core functionality\nwith additional support for\n[font specimens][font-docs], [color palettes][color-preview],\n[sizes and ratios][size-preview], [SVG icons][icon-docs],\n[compiled languages][example-docs], Nunjucks/Jinja macros, HTML previews,\nand more.\n\n[font-docs]: https://www.oddbird.net/herman/docs/demo_fonts\n[color-preview]: https://www.oddbird.net/herman/docs/demo_colors\n[size-preview]: https://www.oddbird.net/herman/docs/demo_sizes\n[icon-docs]: https://www.oddbird.net/herman/docs/demo_icons\n[example-docs]: https://www.oddbird.net/herman/docs/demo_examples\n\n## Getting Started\n\n```bash\nnpm install sassdoc sassdoc-theme-herman\n```\n\nNote: Dart Sass (`sass`)\nis required to use Herman\nto display samples of Sass/Scss code.\nIf it's not already installed in your project,\ninstall it along with Herman:\n\n```bash\nnpm install sass\n```\n\nSee the [SassDoc documentation](http://sassdoc.com/getting-started/)\nto run SassDoc via various build tools.\nSpecify `herman` as the theme\nin your SassDoc options:\n\n```bash\nsassdoc \u003csrc\u003e --theme herman\n```\n\n### SassDoc Comments\n\nCurrently,\nall SassDoc/Herman annotations are written as Sass comments\nstarting with `///` to differentiate documentation\nfrom other developer comments (`//`).\n\n```scss\n// This comment will be ignored by Herman\n/// This comment will be rendered in the documentation\n```\n\nAnnotation comments can be free-floating,\nor attached to a particular Sass/CSS object --\nsuch as a variable, mixin, function, or selector block.\nNote that while SassDoc allows annotation comments\nto be separated from the documented code by newlines,\nHerman considers documentation to be free-floating \"prose\" if\nit is separated from documented code by one or more newlines.\n\n```scss\n/// this is a free-floating comment\n\n/// this comment is attached to the following mixin code-block\n@mixin sample-object { … }\n```\n\n### Herman Annotations\n\nIn addition to the core SassDoc annotations,\nour [`@icons` annotation][icon-docs] allows you to\ndisplay SVG icons from a given folder,\nand we extend the core [`@example` annotation][example-docs]\nto display compiled Sass/Nunjucks output\nand render sample components.\nWe also provide a [`@font` annotation][font-docs]\nfor displaying font-specimens,\nand `@colors`, `@sizes`, and `@ratios` annotations\nfor displaying [color-palettes][color-preview],\n[text and spacing sizes, and modular ratios][size-preview].\n\n[herman]: https://www.oddbird.net/herman/\n[oddbird]: https://www.oddbird.net/\n[sassdoc]: http://sassdoc.com/\n\n[See the full documentation for details »][docs]\n\n[docs]: https://www.oddbird.net/herman/docs/configuration\n\n## SassDoc Extras\n\nHerman uses a number of SassDoc Extras:\n\n- [Description](http://sassdoc.com/extra-tools/#description-description-descriptionpath)\n- [Display](http://sassdoc.com/extra-tools/#display-toggle-display)\n- [GroupName](http://sassdoc.com/extra-tools/#groups-aliases-groupname)\n- [ShortcutIcon](http://sassdoc.com/extra-tools/#shortcut-icon-shortcuticon)\n- [Sort](http://sassdoc.com/extra-tools/#sort-sort)\n- [ResolveVariables](http://sassdoc.com/extra-tools/#resolved-variables-resolvevariables)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foddbird%2Fsassdoc-theme-herman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foddbird%2Fsassdoc-theme-herman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foddbird%2Fsassdoc-theme-herman/lists"}