Back to Project List

KnowledgeBase.Tech

Modern open-source knowledge base using markdown

Respository Video ▶️

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 image

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
Bodhish Thomas
Gigin Chandy George
Vinu TV
Vignesh Hari

Deployed v0.0.12 and created a video. Wrapping for today :D

November 14, 2021

Added an option to white label the site design with config.js and published a new version of the package

November 14, 2021

Created a new package to initialize an app with a minimal theme. Need to build a showcase example and complete the rest.

V1 Status

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

Ship out MVP with a landing page, category index, and show page.

Landing page

image

Category Index

image

Show Page

image

November 13, 2021

Created a wireframe for the product. image

November 13, 2021

Created a wireframe for the product. https://user-images.githubusercontent.com/14979190/141607202-6b8884ac-19be-4a3e-a700-b82a8e70b2ff.png

November 13, 2021

Project created by Bodhish Thomas

November 13, 2021