{"id":15259693,"url":"https://github.com/kelvinbiffi/guide-book","last_synced_at":"2026-02-07T16:32:05.362Z","repository":{"id":57256620,"uuid":"330058364","full_name":"kelvinbiffi/Guide-Book","owner":"kelvinbiffi","description":"A Design System or/and Style Guide generator based on your CSS Files","archived":false,"fork":false,"pushed_at":"2021-05-16T16:02:42.000Z","size":20,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-07T10:11:41.340Z","etag":null,"topics":["css","generator","hacktoberfest","javascript","less","nodejs","pattern","scss","styleguide","stylus"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/guide-book-generator","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/kelvinbiffi.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":"2021-01-16T01:17:00.000Z","updated_at":"2024-05-31T00:01:26.000Z","dependencies_parsed_at":"2022-08-25T02:31:00.838Z","dependency_job_id":null,"html_url":"https://github.com/kelvinbiffi/Guide-Book","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/kelvinbiffi/Guide-Book","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kelvinbiffi%2FGuide-Book","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kelvinbiffi%2FGuide-Book/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kelvinbiffi%2FGuide-Book/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kelvinbiffi%2FGuide-Book/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kelvinbiffi","download_url":"https://codeload.github.com/kelvinbiffi/Guide-Book/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kelvinbiffi%2FGuide-Book/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266602773,"owners_count":23954694,"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","status":"online","status_checked_at":"2025-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","generator","hacktoberfest","javascript","less","nodejs","pattern","scss","styleguide","stylus"],"created_at":"2024-09-30T03:08:48.234Z","updated_at":"2026-02-07T16:32:05.217Z","avatar_url":"https://github.com/kelvinbiffi.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Guide Book\n\nThe **Guide Book** Generator for Style Guides.\n\n----------------------------\n\n## How it works:\n\nThe **Guide Book** goal is to look for the predefined pattern, [showing here](#how-to-use), and use it to generate an HTML page showing the Categories, Elements, and Modules of your Style Guide.\n\n----------------------------\n\n## How to use\n\nFirst of all on your **Source Files** (SCSS/SASS/STYLUS/LESS) use the below pattern:\n```\n/*GUIDE\n\n\u003cCATEGORY\u003e|\u003cSECTION\u003e\n\n\u003cHTML\u003e\n\n*/\n```\n\n### Where\n| PLACEBOLDER         | Description                            |\n|---------------------|----------------------------------------|\n| `\u003cCATEGORY\u003e`        | Category of the Example                |\n| `\u003cSECTION\u003e`         | Sections of the example                |\n| `\u003cHTML\u003e`            | Some HTML Elements                     |\n\n----------------------------\n\n## How to Setup\n\nTo setup the **Guide Book** create a JS file at main folder of your project, using as reference the below code:\n\n```\nconst GuideBook = require('guide-book-generator');\n\nconst settings = {\n  style: \u003cBUILT_CSS_FILE\u003e,\n  source: \u003cSOURCE_FOLDER\u003e,\n  output: \u003cOUTPUT\u003e,\n}\n\nconst guideBook = new GuideBook();\nguideBook.generate(settings);\n```\n\n### Where\n| PLACEBOLDER         | Type            | Description                                                |   Example                 |\n|---------------------|-----------------|------------------------------------------------------------|---------------------------|\n| `\u003cBUILT_CSS_FILE\u003e`  | String          | The built style css file                                   | 'build/style.min.css'     |\n| `\u003cSOURCE_FOLDER\u003e`   | String          | The Source Files (SCSS,STYLUS,LESS,...)                    | 'source/css'              |\n| `\u003cOUTPUT\u003e`          | String          | The **folder** or **file** to generate the **Guide Book**  | 'guidebook/guide.html'    |\n\n----------------------------\n\n## Examples\n\nTo see examples access this Repository [Guide-Book-Example](https://github.com/kelvinbiffi/Guide-Book-Example)\n\n----------------------------\n\n## Requirements Version\n\n- Node `v12.18.1`\n- NPM  `6.14.5`\n\n----------------------------\n\n## Dependences\n\n- [PrismJS](https://prismjs.com/)\n\n----------------------------\n\n## LICENCE\n\nThis project is licensed under the MIT License - see the [LICENSE.md](./LICENSE.md) file for details","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkelvinbiffi%2Fguide-book","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkelvinbiffi%2Fguide-book","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkelvinbiffi%2Fguide-book/lists"}