{"id":18576587,"url":"https://github.com/mmomtchev/documentation-hipster","last_synced_at":"2026-01-23T07:37:00.060Z","repository":{"id":57685884,"uuid":"490736256","full_name":"mmomtchev/documentation-hipster","owner":"mmomtchev","description":"documentation.js Bootstrap Theme with TypeScript and React support","archived":false,"fork":false,"pushed_at":"2023-10-06T16:31:52.000Z","size":1059,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-29T14:27:01.778Z","etag":null,"topics":["documentation","documentation-generator","hipster","theme"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mmomtchev.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-10T14:36:13.000Z","updated_at":"2022-05-13T16:34:30.000Z","dependencies_parsed_at":"2025-01-02T14:32:00.639Z","dependency_job_id":null,"html_url":"https://github.com/mmomtchev/documentation-hipster","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/mmomtchev/documentation-hipster","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmomtchev%2Fdocumentation-hipster","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmomtchev%2Fdocumentation-hipster/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmomtchev%2Fdocumentation-hipster/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmomtchev%2Fdocumentation-hipster/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mmomtchev","download_url":"https://codeload.github.com/mmomtchev/documentation-hipster/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mmomtchev%2Fdocumentation-hipster/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28683672,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-23T05:48:07.525Z","status":"ssl_error","status_checked_at":"2026-01-23T05:48:07.129Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["documentation","documentation-generator","hipster","theme"],"created_at":"2024-11-06T23:25:31.105Z","updated_at":"2026-01-23T07:37:00.042Z","avatar_url":"https://github.com/mmomtchev.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# documentation-hipster\n\n[![License: ISC](https://img.shields.io/github/license/mmomtchev/documentation-hipster)](https://github.com/mmomtchev/documentation-hipster/blob/main/LICENSE)\n[![Node.js CI](https://github.com/mmomtchev/documentation-hipster/actions/workflows/node.js.yml/badge.svg)](https://github.com/mmomtchev/documentation-hipster/actions/workflows/node.js.yml)\n\n`documentation-hipster` is a `react-styleguidist`-inspired theme for [documentation.js](https://documentation.js.org) with support for TypeScript and React components\n\n![Style by Andre from NounProject.com](https://raw.githubusercontent.com/mmomtchev/documentation-hipster/main/hipster.svg)\n*Logo **Style by Andre** from NounProject.com*\n\nYou can check an example documentation that uses it here: [rlayers](https://mmomtchev.github.io/rlayers/api)\n\n![rlayers API screenshot](https://raw.githubusercontent.com/mmomtchev/documentation-hipster/main/screenshot.png)\n\n# Usage\n\nInstall\n```\nnpm i --save-dev documentation-hipster\n```\n\nRun\n```\ndocumentation build ... --theme=node_modules/documentation-hipster/index.js\n```\n\n# Using with React Components\n\n`documentation-hipster` supports the non-standard JSDoc tag `@propsfor` that allows to link the properties interface definition to the component.\n\n# Browse the Shops\n\n(...in their next versions...stay tuned ...)\n\n[rlayers](https://mmomtchev.github.io/rlayers/api) - React Component in TypeScript\n\n[gdal-async](https://mmomtchev.github.io/node-gdal-async) - Node.js addon in C++/JS with [documentation-polyglot](https://github.com/mmomtchev/documentation-polyglot)\n\n# Customization\n\n## Configuration File\n\n`documentation-hipster` supports the following options in the `documentation.yml` configuration file:\n```yml\ndocumentation-hipster:\n  # Disable the warning that multiple elements share the same base name\n  # and cannot have their automatic cross links resolved\n  crossLinksDupeWarning: false\n  # An external function that must be the default export of the following file\n  # Will get called every time a symbol is resolved to allow linking to external documentations\n  # Check the rlayers project for an example\n  externalCrossLinks: scripts/externalCrossLinks.js\n  # If present every element will link to its source code\n  srcLinkBase: https://github.com/mmomtchev/node-gdal-async/blob/master/\n  # All CSS classes may be changed from these defaults\n  classes:\n    container: 'container d-flex flex-row',\n    nav: 'position-sticky nav-section list',\n    main: 'main-section ps-3',\n    title: 'mt-2 mb-3 me-2',\n    examples: 'ms-4',\n    mainItem: 'me-1',\n    navItem: 'd-flex flex-row align-items-center',\n    navCollapse: 'btn btn-collapse m-0 me-2 p-0 align-items-center',\n    navList: 'list-group',\n    navListItem: 'list-group-item border-0',\n    navLink: 'text-decoration-none',\n    navText: 'm-0',\n    paramsTable: 'table table-light',\n    paramsParameterHeader: 'col-2',\n    paramsTypeHeader: 'col-4',\n    paramsDescriptionHeader: 'col-6',\n    paramsParameterData: '',\n    paramsTypeData: '',\n    paramsDescriptionData: '',\n    returns: 'me-1',\n    source: 'ms-auto fs-6 fw-lighter'\n  # Completely replace the built-in CSS\n  css: my.css\n  # Add some classes to the built-in CSS\n  extraCss: scripts/gdal-doc.css\n```\n\n## Total Conversions\n\n`documentation-hipster` uses [Bootstrap](https://getbootstrap.com) and [Handlebars](https://handlebarsjs.com). Simply copy the `documentation-hipster` directory to your project and edit the templates in `./hbs`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmmomtchev%2Fdocumentation-hipster","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmmomtchev%2Fdocumentation-hipster","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmmomtchev%2Fdocumentation-hipster/lists"}