Skip to content

noxify/renoun-docs-template

Repository files navigation

Note: This template is work in progress. The last commit includes my latest changes :) Feel free to use it - If you think you can improve it, please open a PR <3

This is a nextjs template with renoun integration to render mdx content.

  • NextJS 14
  • Tailwind
  • shadncn
  • next-theme to support dark/light mode
  • Fulltext search via pagefind & Search UI by canary web components

Credits

Special thanks

  • 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 <3
  • 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 <3

Known errors

Sidebar flickering

The sidebar is currently flickering if you resize the window to check how it looks like in the mobile view.

This seems to be only a problem while running pnpm dev

Loading indicator for the search

While running the page in dev mode, I mentioned that the loading indicator will not disappear.

Based 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.