DEV Community

Cover image for Knowledge base or documentation site builder
akpvt
akpvt

Posted on

Knowledge base or documentation site builder

Use https://nextra.site/

  • Uses Markdown (.md files). You can write all your content in Markdown
  • Easy way to organize pages and folders
  • Full-text search, zero-config needed.
  • Static site built with simple set of tools
  • Uses Next.js

powered by https://vercel.com/

Sites using this tool for their documentation:

Installation/Getting Started:

  1. git clone https://github.com/shuding/nextra-docs-template
  2. cd nextra-docs-template
  3. npm install
  4. npm run dev
  5. go to your site on your local at http://localhost:3000/

Image description

made one simple update to the /pages/index.mdx to link to my dev.to profile. See the screenshot of the documentation site built under 2mins from the git repo mentioned in step #1 above!

Image description

Happy Documentation site building!

Sentry image

See why 4M developers consider Sentry, “not bad.”

Fixing code doesn’t have to be the worst part of your day. Learn how Sentry can help.

Learn more

Top comments (2)

Collapse
 
johannes_k_rexx profile image
johnblommers

This looks very interesting. Let me install and work with this for a bit.

BTW right after the git clone operation the user must cd nextra-docs-template before proceeding with the npm install step.

Collapse
 
akpvt profile image
akpvt • Edited

Hope you like it as much as I am liking it. Cool thing is that it offers page navigation at the bottom and automatically provides right side navigation of the page sections.

Thanks for pointing out the missing step. The post is updated now.

Bump.sh

Hate writing docs?

Hate undocumented APIs even more?

Bump.sh generates an always up-to-date API reference site for REST and Event-Driven Architectures.

Plug it in your CI. It fetches your OpenAPI and AsyncAPI (GraphQL pending) spec files, and even generates a diff. Gather all of your API docs in a single source of truth.

Try it for free

👋 Kindness is contagious

Please leave a ❤️ or a friendly comment on this post if you found it helpful!

Okay