- 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:
- https://developer.gsmtasks.com/ developer documentation site for https://gsmtasks.com
- https://www.promptingguide.ai/
Installation/Getting Started:
- git clone https://github.com/shuding/nextra-docs-template
- cd nextra-docs-template
- npm install
- npm run dev
- go to your site on your local at http://localhost:3000/
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!
Happy Documentation site building!
Top comments (2)
This looks very interesting. Let me install and work with this for a bit.
BTW right after the
git clone
operation the user mustcd nextra-docs-template
before proceeding with thenpm install
step.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.