{"id":26671131,"url":"https://github.com/scaleapi/custom-documentation-example","last_synced_at":"2026-02-16T09:31:51.817Z","repository":{"id":75293616,"uuid":"300369230","full_name":"scaleapi/custom-documentation-example","owner":"scaleapi","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-24T17:58:00.000Z","size":249,"stargazers_count":68,"open_issues_count":2,"forks_count":9,"subscribers_count":59,"default_branch":"main","last_synced_at":"2025-07-11T16:55:18.228Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"custom-documentation-example.vercel.app","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/scaleapi.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,"zenodo":null}},"created_at":"2020-10-01T17:43:10.000Z","updated_at":"2025-04-24T23:57:38.000Z","dependencies_parsed_at":"2025-04-12T04:13:20.184Z","dependency_job_id":"693a9c2b-082a-4d1c-bad2-8a1556f6f01f","html_url":"https://github.com/scaleapi/custom-documentation-example","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/scaleapi/custom-documentation-example","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scaleapi%2Fcustom-documentation-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scaleapi%2Fcustom-documentation-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scaleapi%2Fcustom-documentation-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scaleapi%2Fcustom-documentation-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scaleapi","download_url":"https://codeload.github.com/scaleapi/custom-documentation-example/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scaleapi%2Fcustom-documentation-example/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29504744,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-16T09:05:14.864Z","status":"ssl_error","status_checked_at":"2026-02-16T08:55:59.364Z","response_time":115,"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":[],"created_at":"2025-03-25T23:43:56.694Z","updated_at":"2026-02-16T09:31:51.800Z","avatar_url":"https://github.com/scaleapi.png","language":"JavaScript","readme":"# Welcome to Custom Documentation Example!\n\n![custom ui documentation](https://user-images.githubusercontent.com/18171127/96633996-44c2cc00-12f0-11eb-999b-ae9330d0a6c5.png)\n \nIn this example you'll find an easy and slick way to implement your [Readme](https://readme.com/) content in a custom front-end using [Next.js](https://nextjs.org/) and [Tailwind](https://tailwindcss.com/).\n\n## Getting Started\n\n### Install\n\n```bash\nyarn install\n# or\nnpm install\n```\n\n### Run\n\n```bash\nyarn dev\n# or\nnpm run dev\n```\n\nOpen [http://localhost:3000](http://localhost:3000) with your browser to see the result, this will redirect you to [http://localhost:3000/docs](http://localhost:3000/docs) where you'll be able to read the instructions on how to connect and modify the example.\n\n### Set up environment variables\n\nIn the Readme dashboard go get your API KEY in the Configuration \u003e API KEY tab.\n\nNext, copy the `.env.local.example` file in this directory to `.env.local` (which will be ignored by Git):\n\n```bash\ncp .env.local.example .env.local\n```\n\nThen set each variable on `.env.local`:\n\n- `README_AUTH_TOKEN` should be the API token you just copied.\n\nYour `.env.local` file should look like this:\n\n```bash\nREADME_AUTH_TOKEN=...\n```\n\n## Learn More\n\nTo learn more about Next.js, take a look at the following resources:\n\n- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.\n- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.\n\nYou can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!\n\nTo learn more about Tailwind, take a look at the following resources:\n\n- [Tailwind Documentation](https://tailwindcss.com/docs/installation) - learn about Tailwind customization features.\n\nTo learn more about Readme, take a look at the following resources:\n\n- [Readme Documentation](https://docs.readme.com/developers/reference/intro) - learn about Readme features and API.\n\n\n## Deploy on Vercel\n\nThe easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/import/git?c=1\u0026s=https://github.com/scaleapi/custom-documentation-example\u0026env=README_AUTH_TOKEN\u0026envDescription=Required%20to%20connect%20the%20app%20with%20ReadMe\u0026envLink=https://github.com/scaleapi/custom-documentation-example%23set-up-environment-variables) from the creators of Next.js.\n\nCheck out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscaleapi%2Fcustom-documentation-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscaleapi%2Fcustom-documentation-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscaleapi%2Fcustom-documentation-example/lists"}