{"id":15155401,"url":"https://github.com/noxify/renoun-docs-template","last_synced_at":"2025-05-02T08:30:34.111Z","repository":{"id":253627057,"uuid":"844056493","full_name":"noxify/renoun-docs-template","owner":"noxify","description":null,"archived":false,"fork":false,"pushed_at":"2024-10-23T21:07:37.000Z","size":1500,"stargazers_count":3,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-24T09:11:04.567Z","etag":null,"topics":["build","generic","mdx","multi-documentation","nextjs","renoun","shadcn-ui","static","tailwind","tailwindcss","template","turbo","turborepo"],"latest_commit_sha":null,"homepage":"https://renoun-docs-template.vercel.app/","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/noxify.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":"2024-08-18T08:43:41.000Z","updated_at":"2024-10-14T09:15:54.000Z","dependencies_parsed_at":"2024-08-18T10:25:15.160Z","dependency_job_id":"f97644cf-320b-43eb-b912-1cab64d32cdf","html_url":"https://github.com/noxify/renoun-docs-template","commit_stats":{"total_commits":72,"total_committers":2,"mean_commits":36.0,"dds":0.02777777777777779,"last_synced_commit":"4d9a0629dbd22be287305026586cd34dbebf5c28"},"previous_names":["noxify/mdxts-docs-template","noxify/omnidoc-docs-template","noxify/renoun-docs-template"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noxify%2Frenoun-docs-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noxify%2Frenoun-docs-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noxify%2Frenoun-docs-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noxify%2Frenoun-docs-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/noxify","download_url":"https://codeload.github.com/noxify/renoun-docs-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224305847,"owners_count":17289446,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["build","generic","mdx","multi-documentation","nextjs","renoun","shadcn-ui","static","tailwind","tailwindcss","template","turbo","turborepo"],"created_at":"2024-09-26T18:21:21.551Z","updated_at":"2024-11-12T16:04:59.985Z","avatar_url":"https://github.com/noxify.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e **Note**: This template is work in progress. The last commit includes my latest changes :)\n\u003e Feel free to use it - If you think you can improve it, please open a PR \u003c3\n\nThis is a nextjs template with renoun integration to render mdx content.\n\n- NextJS 15\n- Tailwind\n- shadncn\n- next-theme to support dark/light mode\n- Fulltext search via pagefind \u0026 Search UI by canary web components\n\n## Credits\n\n- Table of contents: https://github.com/shadcn-ui/ui/blob/main/apps/www/components/toc.tsx\n  - Used this as base and updated it to make it work with the generated headings from renoun\n- Sidebar: https://github.com/shadcn-ui/ui/tree/main/apps/www/registry/new-york/block/sidebar-01\n- Aria Docs: https://github.com/nisabmohd/Aria-Docs\n- Site Header: https://github.com/nisabmohd/Aria-Docs\n- Home Page: https://github.com/nisabmohd/Aria-Docs\n- renoun: https://github.com/souporserious/renoun\n- Search engine: https://github.com/cloudcannon/pagefind\n- Search UI: https://github.com/fastrepl/canary\n\n## Special thanks\n\n- [souporserious](https://github.com/souporserious) for creating renoun and spending a lot of time to answer my questions and reviewing my PRs - Without your awesome package, this repo wouldn't exists \u003c3\n- [yujonglee](https://github.com/yujonglee) for creating the almost perfect search web component which contains a lot of features to provide a good search experience for the user. Thanks for taking the time to answer all my questions \u003c3\n\n## Known errors\n\n### Sidebar flickering\n\nThe sidebar is currently flickering if you resize the window to check how it looks like in the mobile view.\n\n\u003e **This seems to be only a problem while running `pnpm dev`**\n\n### Loading indicator for the search\n\nWhile running the page in dev mode, I mentioned that the loading indicator will not disappear.\n\nBased on what I have seen so far, it seems like the issue occours only on initial load of the page. If you refresh the page, everything works as expected.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnoxify%2Frenoun-docs-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnoxify%2Frenoun-docs-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnoxify%2Frenoun-docs-template/lists"}