{"id":21158288,"url":"https://github.com/simbo/metalsmith-robotskirt","last_synced_at":"2025-03-14T15:27:12.400Z","repository":{"id":24652429,"uuid":"28062454","full_name":"simbo/metalsmith-robotskirt","owner":"simbo","description":"A Metalsmith plugin to convert markdown files with Robotskirt, a node wrapper for Sundown.","archived":false,"fork":false,"pushed_at":"2014-12-23T16:33:37.000Z","size":212,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-21T09:09:21.951Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/simbo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-12-16T00:12:39.000Z","updated_at":"2016-12-26T05:53:20.000Z","dependencies_parsed_at":"2022-08-29T08:02:21.066Z","dependency_job_id":null,"html_url":"https://github.com/simbo/metalsmith-robotskirt","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simbo%2Fmetalsmith-robotskirt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simbo%2Fmetalsmith-robotskirt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simbo%2Fmetalsmith-robotskirt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simbo%2Fmetalsmith-robotskirt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simbo","download_url":"https://codeload.github.com/simbo/metalsmith-robotskirt/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243599811,"owners_count":20317167,"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-20T12:19:33.930Z","updated_at":"2025-03-14T15:27:12.371Z","avatar_url":"https://github.com/simbo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"metalsmith-robotskirt\n=====================\n\n  \u003e A [Metalsmith](https://github.com/segmentio/metalsmith) plugin to convert\n  \u003e markdown files with [Robotskirt](https://github.com/benmills/robotskirt),\n  \u003e a node wrapper for [Sundown](https://github.com/vmg/sundown).\n\n[![npm Package Version](https://img.shields.io/npm/v/metalsmith-robotskirt.svg?style=flat-square)](https://www.npmjs.com/package/metalsmith-robotskirt)\n[![MIT License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://simbo.mit-license.org)\n[![Dependencies Status](https://img.shields.io/david/simbo/metalsmith-robotskirt.svg?style=flat-square)](https://david-dm.org/simbo/metalsmith-robotskirt)\n[![devDependencies Status](https://img.shields.io/david/dev/simbo/metalsmith-robotskirt.svg?style=flat-square)](https://david-dm.org/simbo/metalsmith-robotskirt#info=devDependencies)\n[![Travis Build Status](https://img.shields.io/travis/simbo/metalsmith-robotskirt/master.svg?style=flat-square)](https://travis-ci.org/simbo/metalsmith-robotskirt)\n[![Code Climate GPA](https://img.shields.io/codeclimate/github/simbo/metalsmith-robotskirt.svg?style=flat-square)](https://codeclimate.com/github/simbo/metalsmith-robotskirt)\n\n\n## Installation\n\n``` sh\n$ npm install metalsmith-robotskirt\n```\n\n\n## CLI Usage\n\nInstall via npm and then add the metalsmith-robotskirt key to your\n_metalsmith.json_ with any options you want, like so:\n\n``` json\n{\n  \"plugins\": {\n    \"metalsmith-robotskirt\": {\n      \"smartypants\": true,\n      \"extensions\": {\n        \"tables\": true\n      }\n    }\n  }\n}\n```\n\n\n## Javascript Usage\n\nPass options to the plugin and pass it to Metalsmith with the use method:\n\n``` javascript\nvar robotskirt = require('metalsmith-robotskirt');\n\nmetalsmith.use(robotskirt({\n    smartypants: true,\n    extensions: {\n        tables: true\n    }\n}));\n```\n\n\n## Options\n\nAll options are optional...\n\n\n### Defaults\n\n``` javascript\nvar defaults = {\n    extensions: {\n        autolink: true,\n        fenced_code: true,\n        lax_spacing: true,\n        no_intra_emphasis: true,\n        space_headers: true,\n        strikethrough: true,\n        superscript: true,\n        tables: true\n    },\n    htmlFlags: {\n        skip_html: false,\n        skip_style: false,\n        skip_images: false,\n        skip_links: false,\n        safelink: false,\n        toc: false,\n        hard_wrap: false,\n        use_xhtml: false,\n        expand_tabs: false,\n        escape: false\n    },\n    renderers: {\n        blockcode: highlightCodeBlocks\n    },\n    smartypants: true\n};\n```\n\n\n### Extensions\n\n  - `autolink`  \n    Parse links even when they are not enclosed in `\u003c\u003e` characters. Autolinks\n    for the http, https and ftp protocols will be automatically detected. Email \n    addresses are also handled, and http links without protocol, but starting\n    with `www.`\n\n  - `fenced_code`  \n    Parse fenced code blocks, PHP-Markdown style. Blocks delimited with 3 or \n    more `~` or backticks will be considered as code, without the need to be\n    indented. An optional language name may be added at the end of the opening\n    fence for the code block\n\n  - `lax_spacing`  \n    HTML blocks do not require to be surrounded by an empty line as in the\n    Markdown standard.\n\n  - `no_intra_emphasis`  \n    Do not parse emphasis inside of words. Strings such as `foo_bar_baz` will\n    not generate `\u003cem\u003e` tags.\n\n  - `space_headers`  \n    A space is always required between the hash at the beginning of a header and\n    its name, e.g. `#this is my header` would not be a valid header.\n\n  - `strikethrough`  \n    Parse strikethrough, PHP-Markdown style. Two `~` characters mark the start\n    of a strikethrough, e.g. `this is ~~good~~ bad`\n\n  - `superscript`  \n    Parse superscripts after the `^` character; contiguous superscripts are\n    nested together, and complex values can be enclosed in parenthesis, e.g.\n    `this is the 2^(nd) time`\n\n  - `tables`  \n    Parse tables, PHP-Markdown style\n\n\n### HTML Flags\n\n  - `skip_html`  \n    Do not allow any user-inputted HTML in the output.\n\n  - `skip_images`  \n    Do not generate any `\u003cimg\u003e` tags.\n\n  - `skip_links`  \n    Do not generate any `\u003ca\u003e` tags.\n\n  - `skip_style`  \n    Do not generate any `\u003cstyle\u003e` tags.\n\n  - `safelink`  \n    Only generate links for protocols which are considered safe.\n\n  - `toc`  \n    Add HTML anchors to each header in the output HTML, to allow linking to each\n    section.\n\n  - `hard_wrap`\n    Insert HTML `\u003cbr\u003e` tags inside on paragraphs where the origin Markdown\n    document had newlines (by default, Markdown ignores these newlines).\n\n  - `use_xhtml`\n    Output XHTML-conformant tags.\n\n  - `expand_tabs`\n\n  - `escape`\n\n\n### Renderers\n\nYou can define your own renderers like this:\n\n``` javascript\nvar robotskirt = require('metalsmith-robotskirt'),\n    highlightjs = require('highlight.js');\n\nfunction highlight(code, lang) {\n    var validLang = lang \u0026\u0026 highlightjs.getLanguage(lang.trim()),\n        highlightedCode = validLang ? highlightjs.highlight(lang, code).value : highlightjs.highlightAuto(code).value,\n        langClass = validLang ? ' class=\"lang-' + lang + '\"' : '';\n    return '\u003cpre\u003e\u003ccode' + langClass + '\u003e' + highlightedCode + '\u003c/code\u003e\u003c/pre\u003e';\n}\n\nmetalsmith.use(robotskirt({\n    renderers: {\n        blockcode: highlight\n    }\n}));\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimbo%2Fmetalsmith-robotskirt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimbo%2Fmetalsmith-robotskirt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimbo%2Fmetalsmith-robotskirt/lists"}