{"id":21352080,"url":"https://github.com/static-dev/spike-html-standards","last_synced_at":"2025-07-20T02:09:02.757Z","repository":{"id":57367478,"uuid":"65760082","full_name":"static-dev/spike-html-standards","owner":"static-dev","description":"A rock solid plugin pack for reshape","archived":false,"fork":false,"pushed_at":"2017-11-03T20:11:39.000Z","size":31,"stargazers_count":3,"open_issues_count":1,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-04-14T05:22:49.931Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://spike.readme.io/docs/html-standards","language":"JavaScript","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/static-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"contributing.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-08-15T19:47:05.000Z","updated_at":"2017-12-27T20:39:42.000Z","dependencies_parsed_at":"2022-08-23T20:10:18.903Z","dependency_job_id":null,"html_url":"https://github.com/static-dev/spike-html-standards","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/static-dev%2Fspike-html-standards","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/static-dev%2Fspike-html-standards/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/static-dev%2Fspike-html-standards/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/static-dev%2Fspike-html-standards/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/static-dev","download_url":"https://codeload.github.com/static-dev/spike-html-standards/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225834368,"owners_count":17531471,"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-22T03:12:30.723Z","updated_at":"2024-11-22T03:12:31.428Z","avatar_url":"https://github.com/static-dev.png","language":"JavaScript","readme":"# Spike HTML Standard Plugin Pack\n\n[![npm](http://img.shields.io/npm/v/spike-html-standards.svg?style=flat)](https://badge.fury.io/js/spike-html-standards) [![tests](http://img.shields.io/travis/static-dev/spike-html-standards/master.svg?style=flat)](https://travis-ci.org/static-dev/spike-html-standards) [![dependencies](http://img.shields.io/david/static-dev/spike-html-standards.svg?style=flat)](https://david-dm.org/static-dev/spike-html-standards) [![coverage](http://img.shields.io/coveralls/static-dev/spike-html-standards.svg?style=flat)](https://coveralls.io/github/static-dev/spike-html-standards)\n\n[Spike html standards](https://spike.readme.io/docs/html-standards) plugin pack for reshape\n\n\u003e :warning: **This package is locked and in maintenance mode -- see [reshape/standard](https://github.com/reshape/standard) for future updates!** :warning:\n\n### Installation\n\n`npm install spike-html-standards -S`\n\n### Usage\n\nThis is nothing more than a light wrapper around a reshape configuration object. Options are filtered into their appropriate plugins internally. All are optional.\n\n```js\nconst reshape = require('reshape')\nconst htmlStandards = require('spike-html-standards')\n\nreshape(htmlStandards(/* options */))\n  .process(someHtml)\n  .then((res) =\u003e console.log(res.output()))\n```\n\nBy default, the html standard plugin pack includes:\n\n- [sugarml](https://github.com/reshape/sugarml), provided as default parser\n- [reshape-expressions](https://github.com/reshape/expressions), default settings\n- [reshape-layouts](https://github.com/reshape/layouts), default settings\n- [reshape-include](https://github.com/reshape/include), default settings\n- [reshape-content](https://github.com/reshape/content) with a `md` function that renders markdown using [markdown-it](https://github.com/markdown-it/markdown-it)\n- [reshape-retext](https://github.com/reshape/retext) with the [smartypants](https://github.com/wooorm/retext-smartypants) plugin\n- [reshape-beautify](https://github.com/reshape/beautify), default settings\n- [reshape-minify](https://github.com/reshape/minify), toggled with the `minify` option which is false by default. When enabled, it will disable `beautify`\n\nBased on the way they are ordered there are a couple limitations to keep in mind:\n\n- You cannot use a layout `block/extend` inside of an `include`\n- Any expression delimiters rendered from a `content` or `retext` transform will be output as plaintext, not as an expression\n- Output from a `content` transform will be processed by `retext` in that order\n\nAny of these plugins can be customized by passing options described below.\n\n### Options\n\n| Name | Description | Default |\n| ---- | ----------- | ------- |\n| **root** | Root path used to resolve layouts and includes | |\n| **filename** | Name of the file being compiled, used for error traces and as the include/layout root if not otherwise provided | |\n| **addDependencyTo** | Object with `addDependency` method that will get file paths for tracked deps from includes/layouts | |\n| **webpack** | Shortcut for webpack users to set the `root` and `addDependencyTo` options more easily. Pass webpack loader context. | |\n| **delimiters** | Delimiters used for html-escaped expressions | `['{{', '}}']` |\n| **unescapeDelimiters** | Delimiters used for unescaped expressions | `['{{{', '}}}']` |\n| **markdown** | Options passed in to [markdown-it](https://github.com/markdown-it/markdown-it) constructor | `{ typographer: true, linkify: true }` |\n| **content** | Options passed to the [reshape-content](https://github.com/reshape/content) plugin | `{ md: renderMarkdown }` |\n| **parser** | custom html parser if desired. pass `false` to use the default html parser | `sugarml` |\n| **retext** | Plugins to be passed to the [reshape-retext](https://github.com/reshape/retext) plugin | `[smartypants]` ([ref](https://github.com/wooorm/retext-smartypants)) |\n| **locals** | Added directly to the output object, used when compiling a reshape template to html | `{}` |\n| **alias** | Alias option to be passed to the [include plugin](https://github.com/reshape/include#options) | |\n| **parserRules** | Alias option to be passed to the [include plugin](https://github.com/reshape/include#options) | |\n| **minify** | Minifies the html output by removing excess spaces and line breaks | `false` |\n\n### License \u0026 Contributing\n\n- Details on the license [can be found here](LICENSE.md)\n- Details on running tests and contributing [can be found here](contributing.md)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstatic-dev%2Fspike-html-standards","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstatic-dev%2Fspike-html-standards","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstatic-dev%2Fspike-html-standards/lists"}