{"id":13991686,"url":"https://github.com/foundation/style-sherpa","last_synced_at":"2025-04-28T07:30:43.739Z","repository":{"id":41828017,"uuid":"42659801","full_name":"foundation/style-sherpa","owner":"foundation","description":"A simple style guide generator.","archived":false,"fork":false,"pushed_at":"2017-12-20T21:53:10.000Z","size":7,"stargazers_count":39,"open_issues_count":5,"forks_count":12,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-04-05T07:33:00.193Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/foundation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-09-17T14:08:02.000Z","updated_at":"2023-02-25T14:16:48.000Z","dependencies_parsed_at":"2022-08-11T18:40:51.114Z","dependency_job_id":null,"html_url":"https://github.com/foundation/style-sherpa","commit_stats":null,"previous_names":["zurb/style-sherpa"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foundation%2Fstyle-sherpa","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foundation%2Fstyle-sherpa/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foundation%2Fstyle-sherpa/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/foundation%2Fstyle-sherpa/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/foundation","download_url":"https://codeload.github.com/foundation/style-sherpa/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251271082,"owners_count":21562487,"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-08-09T14:01:31.665Z","updated_at":"2025-04-28T07:30:42.770Z","avatar_url":"https://github.com/foundation.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# Style Sherpa\n\nStyle Sherpa is a simple style guide generator. It takes a single Markdown file and converts it to a pre-made HTML template with tabbed sections. The template is powered by [Foundation for Sites](http://foundation.zurb.com).\n\n## Installation\n\n```bash\nnpm install style-sherpa --save-dev\n```\n\n## Usage\n\nYour style guide lives in a single Markdown file, which can have any name and sit anywhere in your project. Use first-level headings (a single `#` before a title) to mark new sections in the style guide.\n\n```markdown\n# Section 1\n\nLorem ipsum dolor sit amet, consectetur adipisicing elit. Fuga saepe, vero ratione optio illum aliquam. Sint esse velit est voluptatum. Ipsa tempora saepe nostrum quidem voluptatem esse voluptatum quibusdam laboriosam!\n```\n\nTo create new sections, add four line breaks.\n\n```markdown\n# Section 1\n\nLorem ipsum dolor sit amet, consectetur adipisicing elit. Fuga saepe, vero ratione optio illum aliquam. Sint esse velit est voluptatum. Ipsa tempora saepe nostrum quidem voluptatem esse voluptatum quibusdam laboriosam!\n\n\n\n# Section 2\n\n\u003c!-- ... --\u003e\n```\n\nTo actually run the parser, include the `style-sherpa` library and run the command. At minimum you need file paths for the input and output, but you can also optionally specify a custom template, or supply a callback.\n\n```javascript\nvar sherpa = require('style-sherpa');\n\nsherpa('./test/fixtures/test.md', {\n  output: './test/fixtures/test.html',\n  template: './template.hbs'\n}, cb());\n```\n\n### sherpa(input [, options, callback])\n\nGenerates an HTML style guide from a Markdown file.\n\n#### input\n\n**Type:** `String`\n\nPath to the input Markdown file to parse.\n\n#### options\n\n**Type:** `Object`\n\n- `output` (`String`): Path to output the finished HTML file. Defaults to the current working directory.\n- `template` (`String`): Path to a custom Handlebars template to use, instead of the default one.\n\n### callback\n\n**Type:** `Function`\n\nCallback to run when the file has been written to disk.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoundation%2Fstyle-sherpa","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffoundation%2Fstyle-sherpa","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffoundation%2Fstyle-sherpa/lists"}