{"id":26290956,"url":"https://github.com/thekeineahnung/css-documenation-generator","last_synced_at":"2026-04-14T19:31:44.467Z","repository":{"id":49752226,"uuid":"479835888","full_name":"TheKeineAhnung/css-documenation-generator","owner":"TheKeineAhnung","description":"css-documenation-generator is a tool that automatically generates documentation for CSS files based on the code in the css file.","archived":false,"fork":false,"pushed_at":"2022-07-27T15:20:26.000Z","size":194,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-02T04:42:13.582Z","etag":null,"topics":["css","documentation","markdown","nodejs","typescript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/css-documenation-generator","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TheKeineAhnung.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-04-09T20:25:23.000Z","updated_at":"2024-09-27T16:26:31.000Z","dependencies_parsed_at":"2022-08-25T15:40:07.876Z","dependency_job_id":null,"html_url":"https://github.com/TheKeineAhnung/css-documenation-generator","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/TheKeineAhnung/css-documenation-generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheKeineAhnung%2Fcss-documenation-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheKeineAhnung%2Fcss-documenation-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheKeineAhnung%2Fcss-documenation-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheKeineAhnung%2Fcss-documenation-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TheKeineAhnung","download_url":"https://codeload.github.com/TheKeineAhnung/css-documenation-generator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheKeineAhnung%2Fcss-documenation-generator/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265360405,"owners_count":23752702,"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":["css","documentation","markdown","nodejs","typescript"],"created_at":"2025-03-15T00:25:19.422Z","updated_at":"2026-04-14T19:31:44.433Z","avatar_url":"https://github.com/TheKeineAhnung.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# css-documenation-generator\n\n![Licence](https://img.shields.io/badge/License-CC--BY--3.0-yellow.svg?style=flat-square) ![Version](https://img.shields.io/github/package-json/v/thekeineahnung/css-documenation-generator/main?style=flat-square\u0026label=Version) ![build status](https://img.shields.io/github/workflow/status/thekeineahnung/css-documenation-generator/Test%20build?label=Build\u0026style=flat-square) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)\n\ncss-documenation-generator is a tool that automatically generates documentation for CSS files based on the code in the css file. It is written in TypeScript. Please take a look to the [licence](https://github.com/TheKeineAhnung/css-documenation-generator/blob/main/LICENSE.md) before using it.\n\n## Prerequisites\n\nThis project requires NodeJS (version \u003e= 14.0.0) and NPM. [NodeJS](https://nodejs.org/) and [NPM](https://www.npmjs.com/) are very easy to install. To make sure you have them available, you can try running the following command:\n\n```\nnpm -v \u0026\u0026 node -v\n```\n\n## Installation\n\n```\nnpm install css-documenation-generator\n```\n\n## Quick start\n\nAfter installation you can import the package with in your JavaScript or TypeScript file:\n\n```\nimport { generateCssDocs } from 'css-documenation-generator/build/lib/cssDocumentationGenerator';\n```\n\nTo generate the documentation you can use the following function:\n\n```\ngenerateCssDocs(inputPaths: string[], outputPath: string)\n```\n\nThe inputPaths parameter is an array of paths to the CSS files you want to generate the documentation for. The outputPath parameter is the path to the directory where the documentation will be saved. Both need to be absolute paths.\n\nThe function returns a [StatusObject](https://github.com/TheKeineAhnung/css-documenation-generator/blob/main/lib/types/StatusObject.ts) which contains the following properties:\n\n```\nstatus: Status\nmessage?: string\n```\n\nYou can find information about the `Status` type [here](https://github.com/TheKeineAhnung/css-documenation-generator/blob/main/lib/types/Status.ts)\n\n### Commands\n\n- `npm run dev`: Starts the TypeScript compiler in watch mode.\n- `npm run build`: Starts the TypeScript compiler in build mode.\n\n## Bug reports\n\nHave you found a bug? Please open an [issue](https://github.com/TheKeineAhnung/css-documenation-generator/issues/new).\n\n[cc-by-nc-sa]: http://creativecommons.org/licenses/by-nc-sa/4.0/\n[cc-by-nc-sa-image]: https://licensebuttons.net/l/by-nc-sa/4.0/88x31.png\n[cc-by-nc-sa-shield]: https://img.shields.io/badge/License-CC%20BY--NC--SA--4.0-yellow.svg?style=flat-square\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthekeineahnung%2Fcss-documenation-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthekeineahnung%2Fcss-documenation-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthekeineahnung%2Fcss-documenation-generator/lists"}