{"id":16617046,"url":"https://github.com/wdullaer/raml2html-slate-theme","last_synced_at":"2026-01-27T02:07:16.594Z","repository":{"id":18548673,"uuid":"84581605","full_name":"wdullaer/raml2html-slate-theme","owner":"wdullaer","description":"A slate inspired theme for raml2html","archived":false,"fork":false,"pushed_at":"2025-01-07T03:52:40.000Z","size":2159,"stargazers_count":18,"open_issues_count":12,"forks_count":21,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-08-25T23:59:42.619Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Stylus","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/wdullaer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["wdullaer"]}},"created_at":"2017-03-10T16:53:37.000Z","updated_at":"2024-10-04T06:53:25.000Z","dependencies_parsed_at":"2023-02-10T07:31:09.510Z","dependency_job_id":"82b5fa59-183c-462b-b89d-bda34e84541a","html_url":"https://github.com/wdullaer/raml2html-slate-theme","commit_stats":{"total_commits":292,"total_committers":15,"mean_commits":"19.466666666666665","dds":0.7157534246575342,"last_synced_commit":"ea71962bfb21be3f030c05d9807a4d09e0e111a4"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/wdullaer/raml2html-slate-theme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wdullaer%2Framl2html-slate-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wdullaer%2Framl2html-slate-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wdullaer%2Framl2html-slate-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wdullaer%2Framl2html-slate-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wdullaer","download_url":"https://codeload.github.com/wdullaer/raml2html-slate-theme/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wdullaer%2Framl2html-slate-theme/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28796962,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-27T01:07:07.743Z","status":"online","status_checked_at":"2026-01-27T02:00:07.755Z","response_time":168,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","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":[],"created_at":"2024-10-12T02:15:03.371Z","updated_at":"2026-01-27T02:07:16.565Z","avatar_url":"https://github.com/wdullaer.png","language":"Stylus","funding_links":["https://github.com/sponsors/wdullaer"],"categories":[],"sub_categories":[],"readme":"# raml2html-slate-theme \n[![NPM version][npm-image]][npm-url] ![Build Status][actions-image] [![Dependency Status][daviddm-image]][daviddm-url]\n\n\u003e Render the RAML API spec in the slate documentation layout using raml2html\n\nThis package provides a theme for [raml2html](https://github.com/raml2html/raml2html). It is meant to render nice looking documentation for your REST API, based on a RAML file.\nThe theme is is inspired by [slate](https://github.com/lord/slate).\n\nThe theme is usable, but the templates might still change based upon feedback. Most RAML features are supported.\n\n![Example](https://raw.github.com/wdullaer/raml2html-slate-theme/gh-pages/example-image.png)\n\n## Installation\n\n```sh\n$ npm install -g raml2html-slate-theme\n```\n\n## Usage\nIn javascript:\n```js\nconst raml2html = require('raml2html');\nconst options = {\n  'logo': '/path/to/my/logo.png',\n  'color-theme': 'path/to/my/color-theme.styl',\n  'language-tabs': ['json', 'xml']\n}\nconst slateConfig = raml2html.getConfigForTheme('raml2html-slate-theme', options);\n\n// source can be a filename, url or parsed RAML object\nconst source = 'path/to/raml/file'\nraml2html.render(source, slateConfig)\n  .then((html) =\u003e console.log(html))\n  .catch((error) =\u003e console.error(error))\n```\n\nOn the command line:\n```bash\nraml2html \\\n--theme 'raml2html-slate-theme' \\\n-o 'path/to/output/file.html' \\\n-i 'path/to/raml/file.raml'\n```\n\n## Options\n\n* *--logo* The path to a custom logo\n* *--color-theme* The path to a custom color-theme stylus file\n* *--generate-color-theme* Writes the default color them to stdout and exits. Ideal as a starting point for your own color scheme\n* *--language-tabs* Set an array of serialisation formats to be used for examples. anyOf: ['json', 'xml', 'sse']\n\n## FAQ\n\n### How do I get content in the right column?\nThe theme will render all top level documentation entries as Markdown in seperate sections. In this markdown you can use exactly one `\u003chr/\u003e` (or the markdown equivalent thereof). Everything above the `\u003chr/\u003e` will be rendered in the middle column as usual. Everything below, will be pushed into the right column. This is useful to create documented code examples.\n\nThis example:\n\n```md\nHere is some content that will render in the middle column\n1. Item 1\n2. Item 2\n---\nHere is some content that will render in the right column\n* foo\n* bar\n```\n\nResults in this output:\n\n![hr-example](https://raw.github.com/wdullaer/raml2html-slate-theme/gh-pages/hr-example-image.png)\n\n\u003e You should not use an `\u003chr/\u003e` in a method description. It will currently mess up the layout. I am looking into an elegant way to allow text in the right column there as well.\n\n## TODO\n* Cover all RAML features\n* Allow text in right column for API method descriptions\n\n## License\n\nMIT © [Wouter Dullaert](https://wdullaer.com)\n\n\n[npm-image]: https://badge.fury.io/js/raml2html-slate-theme.svg\n[npm-url]: https://npmjs.org/package/raml2html-slate-theme\n[actions-image]: https://github.com/wdullaer/raml2html-slate-theme/workflows/raml2html-slate-theme/badge.svg\n[daviddm-image]: https://david-dm.org/wdullaer/raml2html-slate-theme.svg?theme=shields.io\n[daviddm-url]: https://david-dm.org/wdullaer/raml2html-slate-theme\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwdullaer%2Framl2html-slate-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwdullaer%2Framl2html-slate-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwdullaer%2Framl2html-slate-theme/lists"}