KnowledgeBase.Tech

A quick overview

⚡️ KnowledgeBase will help you ship a beautiful documentation site in no time.

💸 Building a custom tech stack is expensive. Instead, focus on your content and just write Markdown files.

💥 Ready for more? Use advanced features like versioning, search and theme customizations.

🧐 KnowledgeBase is a static-site generator. It builds a single-page application with a fast client-side navigation, leveraging the full power of NextJs to make your site interactive.

Quick Install

Install Node.js and create a new KnowledgeBase site:

npx knowledgebasetech@latest init my-website

Start the site:

cd my-website
npm run dev

Open http://localhost:3000 and checkout the app.

Documentation

Checkout out knowledgebase.tech for detailed documentation and usage instructions.

V1 Wire Frame

Modern open-source knowledge base using markdown

V1 Features

• [X] A working minimum viable frontend that can list articles.
• [X] A working search inside the landing page
• [X] Options to white label the site design and config
• [X] Configure header and Footer
• [X] Support categories (this can be folders but it's good to have an option to store a small description)
• [x] Publish a package that can be imported to any doc store.
• [ ] Add the concept of Authors for articles

V2 Features

• Support for internationalisation
• CLI tool for page generation