{"id":22796278,"url":"https://github.com/makerxstudio/repository-website-generator","last_synced_at":"2026-05-17T15:09:14.538Z","repository":{"id":40325059,"uuid":"507452981","full_name":"MakerXStudio/repository-website-generator","owner":"MakerXStudio","description":"Generates a Next.js static website by converting markdown to html","archived":false,"fork":false,"pushed_at":"2023-10-06T20:46:00.000Z","size":1924,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-09-15T12:31:07.943Z","etag":null,"topics":["nextjs","oss","package","repository-website-generator","typescript","utils","web"],"latest_commit_sha":null,"homepage":"https://makerxstudio.github.io/repository-website-generator/","language":"TypeScript","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/MakerXStudio.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-06-26T01:38:30.000Z","updated_at":"2022-12-13T02:45:44.000Z","dependencies_parsed_at":"2024-11-25T20:42:20.449Z","dependency_job_id":null,"html_url":"https://github.com/MakerXStudio/repository-website-generator","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"purl":"pkg:github/MakerXStudio/repository-website-generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MakerXStudio%2Frepository-website-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MakerXStudio%2Frepository-website-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MakerXStudio%2Frepository-website-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MakerXStudio%2Frepository-website-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MakerXStudio","download_url":"https://codeload.github.com/MakerXStudio/repository-website-generator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MakerXStudio%2Frepository-website-generator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33143276,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-17T09:28:26.183Z","status":"ssl_error","status_checked_at":"2026-05-17T09:27:52.702Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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":["nextjs","oss","package","repository-website-generator","typescript","utils","web"],"created_at":"2024-12-12T05:11:46.747Z","updated_at":"2026-05-17T15:09:14.518Z","avatar_url":"https://github.com/MakerXStudio.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Repository Website Generator (repository-website-generator)\n\n\u003e Generates a Next.js static website by converting markdown to html\n\n[![npm package][npm-img]][npm-url]\n[![Build Status][build-img]][build-url]\n[![Downloads][downloads-img]][downloads-url]\n[![Issues][issues-img]][issues-url]\n[![Semantic Release][semantic-release-img]][semantic-release-url]\n\n## Install\n\n```bash\nnpm install @makerx/repository-website-generator --save-dev\n```\n\n## Usage\n\nThe repository website can be generated by running the following command\n\n```bash\n npx repository-website-generator\n```\n\nTip: _Make it more discoverable add it to the package.json scripts collection_\n\n```text\n\"scripts\": {\n  \"generate-website\": \"npx repository-website-generator\"\n}\n```\n\n## Testing\n\nAn easy way of testing the generated website is to use the [http-server](https://www.npmjs.com/package/http-server) NPM package.\n\nInstall http-server\n\n```bash\nnpm install --save-dev http-server\n```\n\nAdd the following script to the package.json file\n\n```text\n\"scripts\": {\n  \"serve-generated-website\": \"http-server -c-1 ./out\"\n}\n```\n\nThen build and launch the website\n\n```bash\nnpx repository-website-generator \u0026\u0026 npm run serve-generated-website\n```\n\n## Miscellaneous Pages\n\nMiscellaneous pages can be enabled by setting the following configuration option.\n\n```text\n  \"miscellaneousPages\": {\n    \"path\": \"/public-pages\"\n  },\n```\n\nAny markdown pages added to the `/public-pages` directory will be included in the build.\n\nA miscellaneous markdown page has a special format to allow page related configuration settings. The format is:\n\n```text\n---\ntitle: Test Page\nslug: test-page\nmenuIndex: 1\n---\n\n## A sub-title\n```\n\nThe title property is to set the page title when showing the page.\n\nThe slug controls the link to the page. The links for miscellaneous pages are rooted. For this example, in the page above, the link would be `http://localhost:3000/test-page`.\n\nThe menuIndex is an optional property. Setting it allows for the control of the miscellaneous page link position.\n\n## Code Docs\n\nCurrently, only code docs generated by [typedoc](https://typedoc.org/) are supported.\n\nTo add typedoc to a solution the follow steps can be taken.\n\nEnable code doc support in website-generator.json file\n\n```text\n  \"codeDocs\": {\n    \"path\": \"/code-docs\"\n  },\n```\n\nInstall the packages:\n\n```bash\nnpm install typedoc, typedoc-plugin-markdown --save-dev\n```\n\nThen add a script entry:\n\n```text\n\"scripts\": {\n  \"generate-doc\": \"typedoc\",\n}\n```\n\nAnd lastly, add the typedoc.json configuration file:\n\n```json\n{\n  \"entryPoints\": [\"pages/\", \"shared/\", \"components/\"],\n  \"entryPointStrategy\": \"expand\",\n  \"out\": \"code-docs\",\n  \"plugin\": [\"typedoc-plugin-markdown\"],\n  \"theme\": \"default\",\n  \"cleanOutputDir\": true,\n  \"githubPages\": false,\n  \"readme\": \"none\",\n  \"entryDocument\": \"code-docs.md\",\n  \"publicPath\": \"/\"\n}\n```\n\n_Note: the out path for the doc generator must match the `codeDocs` path defined in the generator configuration._\n\n## Configuration options\n\nThe configuration file is a json file named `website-generator.json`, and must be placed at the same level as the package.json file.\n\n### Starting configuration file\n\n```json\n{\n  \"outPath\": \"/out\",\n  \"rootPath\": null,\n  \"readmeFileName\": null,\n  \"title\": \"My Package name\",\n  \"titleSuperscript\": \"Proudly built and maintained by [MakerX](https://makerx.com.au)\",\n  \"author\": null,\n  \"name\": null,\n  \"description\": null,\n  \"gitHubUrl\": null,\n  \"soeTags\": null,\n  \"assetsPath\": null,\n  \"miscellaneousPages\": null,\n  \"codeDocs\": null,\n  \"theme\": {\n    \"iconLogo\": \"/theme/makerx-icon.png\",\n    \"imageLogo\": \"/theme/makerx-logo.png\",\n    \"imageLogoLink\": \"https://makerx.com.au\"\n  },\n  \"attribution\": []\n}\n```\n\n### Example configuration file\n\n```json\n{\n  \"outPath\": \"/out\",\n  \"rootPath\": null,\n  \"readmeFileName\": null,\n  \"title\": \"TS Type Helpers\",\n  \"titleSuperscript\": \"Proudly built and maintained by [MakerX](https://makerx.com.au)\",\n  \"author\": null,\n  \"name\": null,\n  \"description\": null,\n  \"gitHubUrl\": null,\n  \"soeTags\": null,\n  \"assetsPath\": \"/public-assets\",\n  \"miscellaneousPages\": {\n    \"path\": \"/public-pages\"\n  },\n  \"codeDocs\": {\n    \"path\": \"/code-docs\"\n  },\n  \"theme\": {\n    \"iconLogo\": \"/theme/makerx-icon.png\",\n    \"imageLogo\": \"/theme/makerx-logo.png\",\n    \"imageLogoLink\": \"https://makerx.com.au\"\n  },\n  \"attribution\": [\n    {\n      \"group\": \"Referenced packages\",\n      \"title\": \"react\",\n      \"description\": \"React is a JavaScript library for creating user interfaces.\",\n      \"license\": \"MIT\",\n      \"link\": \"github.com/facebook/react\"\n    },\n    {\n      \"group\": \"Referenced packages\",\n      \"title\": \"react-dropzone\",\n      \"description\": \"Simple React hook to create a HTML5-compliant drag'n'drop zone for files.\",\n      \"license\": \"MIT\",\n      \"link\": \"https://github.com/react-dropzone/react-dropzone\"\n    }\n  ]\n}\n```\n\n### outPath (Required)\n\nWhere the built site will be copied to.\n\n### rootPath (Optional)\n\nThe root path for the reference repository.\n\nNote: _By default the root path value defaults to `/`_\n\n### readmeFileName (Optional)\n\nThe name of the main markdown file that will become in the index content.\n\nNote: _By default the readme file name value is `README.md`_\n\n### title (Required)\n\nThe title of the repository website.\n\n### titleSuperscript (Required)\n\nThe superscript that is rendered with the title.\n\n### author (Optional)\n\nThe author of the package.\n\nNote: _By default the author is referenced from the package.json field `author`_\n\n### name (Optional)\n\nThe name of the package.\n\nNote: _By default the author is referenced from the package.json field `name`_\n\n### description (Optional)\n\nThe description of the package.\n\nNote: _By default the author is referenced from the package.json field `description`_\n\n### gitHubUrl (Optional)\n\nThe GitHub URL link.\n\nNote: _By default the author is referenced from the package.json field `description`_\n\n### soeTags (Optional)\n\nThe description of the package.\n\nNote: _By default the author is referenced from the package.json field `repository.url`_\n\n### assetsPath (Optional)\n\nA directory containing assets.\n\n### miscellaneousPages (Optional)\n\nThe folder containing the miscellaneous markdown files.\n\nSee adding [miscellaneous pages](#miscellaneous-pages)\n\n### codeDocs (Optional)\n\nThe folder containing the code doc markdown files.\n\nSee adding [code docs](#code-docs)\n\n### theme (Required)\n\nTheme is an object with the following properties.\n\n#### theme.iconLogo (Required)\n\nThe icon logo is shown on the index page next to the H1 title.\n\n#### theme.imageLogo (Required)\n\nThe image logo is shown on all pages in the footer.\n\n#### theme.imageLogoLink (Required)\n\nThe link for the image logo.\n\n### Attribution\n\nIs the collection holding additional attribution references which are shown on the attribution page.\n\nThe following properties are available per attribution reference\n\n#### attribution[].group (optional)\n\nAn optional group name. All references of the same group are shown together. The group name is shown once.\n\n#### attribution[].title (required)\n\nThe title of the reference.\n\n#### attribution[].license (required)\n\nThe license of the reference.\n\n#### attribution[].description (optional)\n\nAn optional description of the reference.\n\n#### attribution[].link (optional)\n\nAn optional link to the reference.\n\n[build-img]:https://github.com/MakerXStudio/repository-website-generator/actions/workflows/release.yml/badge.svg\n[build-url]:https://github.com/MakerXStudio/repository-website-generator/actions/workflows/release.yml\n[downloads-img]:https://img.shields.io/npm/dt/@MakerXStudio/repository-website-generator\n[downloads-url]:https://www.npmtrends.com/@makerx/repository-website-generator\n[npm-img]:https://img.shields.io/npm/v/@makerx/repository-website-generator\n[npm-url]:https://www.npmjs.com/package/@makerx/repository-website-generator\n[issues-img]:https://img.shields.io/github/issues/MakerXStudio/repository-website-generator\n[issues-url]:https://github.com/MakerXStudio/repository-website-generator/issues\n[semantic-release-img]:https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svgs\n[semantic-release-url]:https://github.com/semantic-release/semantic-release\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmakerxstudio%2Frepository-website-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmakerxstudio%2Frepository-website-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmakerxstudio%2Frepository-website-generator/lists"}