Settings

Theme

Show HN: File Based Documentation Site – Next.js

docu-phi.vercel.app

4 points by sonnyt 3 years ago · 4 comments · 1 min read

Reader

Hello everyone,

I've been building a simple open-source documentation site on top of Next.js. It works similarly to Next.js' file-based routing system, but instead of JavaScript, it uses Markdown and MDX.

Before I continue, I would like some feedback on whether it would be helpful for y'all. Should I continue or stop?

Any feedback would be appreciated!

hoofhearted 3 years ago

It looks like you're off to a great start!

If you'd like to create your docs site without having to write tons of boilerplate code, then you should check out the framework we built called Elegant.

It puts together Next.js, Tailwind CSS, and MDX Loader to scaffold out a complete server side rendered web app, complete with user docs and and a blog.

I'd love some feedback myself! Do you think Elegant could be of use to you?

https://github.com/elegantframework/elegant-cli

tough 3 years ago

I've seen https://www.contentlayer.dev/ used for similar stuff on open source codebases like taxonomy from shadcn

techn00 3 years ago

Looks bad on mobile

  • sonnytOP 3 years ago

    yep, I haven't gotten to that point yet. Trying to get feedback before I dive too deep into building it out fully. :)

Keyboard Shortcuts

j
Next item
k
Previous item
o / Enter
Open selected item
?
Show this help
Esc
Close modal / clear selection