{"id":26018960,"url":"https://github.com/moonwave99/readme.com","last_synced_at":"2026-04-17T18:31:03.237Z","repository":{"id":191386073,"uuid":"684461590","full_name":"moonwave99/readme.com","owner":"moonwave99","description":"Absolutely simple homepage generator.","archived":false,"fork":false,"pushed_at":"2026-02-21T22:46:19.000Z","size":156,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-22T04:29:41.118Z","etag":null,"topics":["markdown","static-site-generator"],"latest_commit_sha":null,"homepage":"https://moonwave99.github.io/readme.com/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/moonwave99.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-08-29T07:09:49.000Z","updated_at":"2026-02-21T22:46:23.000Z","dependencies_parsed_at":"2023-08-29T17:21:08.890Z","dependency_job_id":null,"html_url":"https://github.com/moonwave99/readme.com","commit_stats":null,"previous_names":["moonwave99/readme.com"],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/moonwave99/readme.com","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moonwave99%2Freadme.com","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moonwave99%2Freadme.com/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moonwave99%2Freadme.com/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moonwave99%2Freadme.com/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/moonwave99","download_url":"https://codeload.github.com/moonwave99/readme.com/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moonwave99%2Freadme.com/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31940661,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-17T17:29:20.459Z","status":"ssl_error","status_checked_at":"2026-04-17T17:28:47.801Z","response_time":62,"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":["markdown","static-site-generator"],"created_at":"2025-03-06T06:39:43.597Z","updated_at":"2026-04-17T18:31:03.231Z","avatar_url":"https://github.com/moonwave99.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Readme.com\n\n[![Build Status](https://github.com/moonwave99/readme.com/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/moonwave99/readme.com/actions?workflow=Test)\n\nFrom `README.md`  \nto `index.html` in one touch\n\n---\n\n## Usage\n\nInside a folder with a `README.md` file:\n\n```txt\nnpx readme.com\n```\n\nYou'll get:\n\n```txt\nout\n  index.html\n  styles.css\n```\n\nThe `styles.css` file provides minimal page styling. You can override it by providing your styles, see below for how to use the `assetsPath` option.\n\n### Automatic content arrangement\n\nThe markdown contents are split at the `---` delimiters and organized in `\u003csection\u003e`, e.g. the following:\n\n```md\n# My Document\n\nSome text\n\n---\n\n## About\n\nSome more text\n\n---\n\n## Contact\n\nSome further text\n```\n\nWill output:\n\n```html\n\u003cnav\u003e\n  \u003ca href=\"#top\"\u003eHome\u003c/a\u003e\n  \u003ca href=\"#some-content\"\u003eAbout\u003c/a\u003e\n  \u003ca href=\"#some-more-content\"\u003eContact\u003c/a\u003e\u003e\n\u003c/nav\u003e\n\u003cmain\u003e\n  \u003csection class=\"top\"\u003e\n    \u003ch1 id=\"my-document\"\u003eMy Document\u003c/h1\u003e\n    \u003cp\u003eSome text\u003c/p\u003e\n  \u003c/section\u003e\n  \u003csection class=\"about\"\u003e\n    \u003ch2 id=\"about\"\u003eAbout\u003c/h2\u003e\n    \u003cp\u003eSome more text\u003c/p\u003e\n  \u003c/section\u003e\n  \u003csection class=\"contact\"\u003e\n    \u003ch2 id=\"contact\"\u003eContact\u003c/h2\u003e\n    \u003cp\u003eSome further text\u003c/p\u003e\n  \u003c/section\u003e\n\u003c/main\u003e\n```\n\nThe `\u003cnav\u003e` is populated accordingly to the content.\n\n### Local development\n\nYou can add the following scripts to your `package.json` in order to test the output locally and eventually building it:\n\n```js\n{\n  \"scripts\": {\n    \"dev:site\": \"npx concurrently 'npx serve site' 'npx nodemon --watch readme.md --exec npm run build:site'\",\n    \"build:site\": \"rm -rf site \u0026\u0026 npx readme.com\"\n  }\n}\n```\n\n- run `npm run dev:site` to see a preview at http://localhost:3000;\n- run `npm run dev:build` to generate the website inside the `outputPath` folder (defaults to `'./out`).\n\nIf you want to deploy your website to [Github Pages](https://docs.github.com/en/pages), configure your repo accordingly and set up an action [like the one used by this library](./.github/workflows/github-pages.yml).\n\n### Include assets\n\nAny files contained in the `assets` folder will be copied over to the output folder and then be available at the same level of the `index.html` file, i.e.:\n\n```txt\nassets\n  robots.txt\n  styles.css\n  image.jpg\nREADME.md\n```\n\nYields:\n\n```txt\nout\n  index.html\n  styles.css  // overwritten\n  robots.txt\n  image.jpg\n```\n\nThe assets folder is configurable via the `assetsPath` option:\n\n```txt\nnpx readme.com --assetsPath ./my-assets-path\n```\n\n### Template override\n\nThe library uses the following [templates](./src/templates):\n\n```txt\nmeta.ejs\nnavbar.ejs\nsection.ejs\nfooter.ejs\nscripts.ejs\nstyles.ejs\n```\n\nYou can override any of them by providing a same named file in a folder called `templates`:\n\n```txt\ntemplates\n  footer.ejs\nREADME.md\n```\n\nAnd your custom footer will be used **instead** of the existing one.\n\nThe custom templates folder is configurable via the `templatesPaths` option:\n\n```txt\nnpx readme.com --templatesPaths ./my-templates-path\n```\n\n---\n\n## Documentation\n\n### Command Line\n\n```txt\nnpx readme.com\n\nGenerates an HTML document from a README.md file\n\nOptions:\n  --help            Show help                                            [boolean]\n  --version         Show version number                                  [boolean]\n  --readmePath      README path               [default: \"{process.cwd}/README.md\"]\n  --outputPath      output path               [default: \"{process.cwd}\"]\n  --templatesPaths  custom templates path\n  --assetsPath      assets path               [default: \"{process.cwd}/assets\"]\n```\n\n### Programmatic usage\n\n```js\nimport { parse, render } from \"readme.com\";\n\nconst { sections, meta } = await parse({\n  readmePath: \"...\", // path to your readme file, defaults to ./README.md\n});\n\nawait render({\n  sections,\n  meta,\n  // additional options here\n});\n```\n\n### Render function options\n\n| Name             | Default value                                | Description                                                           |\n| ---------------- | -------------------------------------------- | --------------------------------------------------------------------- |\n| `cwd`            | `process.cwd`                                | Used to retrieve the `package.json` file                              |\n| `outputPath`     | `./out`                                      | The output folder                                                     |\n| `assetsPath`     | `./assets`                                   | Additional assets folder                                              |\n| `templatesPaths` | `null`                                       | Custom templates folder                                               |\n| `ejsOptions`     | `{ openDelimiter: \"{\", closeDelimiter: \"}\"}` | EJS configuration (in case you provide different formatted templates) |\n\n---\n\n## Examples\n\n- this page!\n- [homepage example](https://moonwave99.github.io/readme.com/examples/personal-website/) ([source](https://github.com/moonwave99/readme.com/tree/main/examples/personal-website))\n- [test-fs](https://moonwave99.github.io/test-fs/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoonwave99%2Freadme.com","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmoonwave99%2Freadme.com","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoonwave99%2Freadme.com/lists"}