Skip to content

A FOSS Self Hosted Documentation Platform with built-in Markdown Editor

Notifications You must be signed in to change notification settings

thePrnvBot/yellow-pages

Repository files navigation

Yellow Pages 📒

Yellow Pages is a developer-friendly platform that seamlessly combines the power of Docusaurus for documentation with the rich editing experience of Tiptap for Markdown-based content creation.

Think of it as your interactive knowledge hub — write, edit, and publish documentation effortlessly, all in one place.


✨ Features

  • Docusaurus-powered site
    Static documentation website with blazing-fast navigation, search, and custom theming.

  • Tiptap Markdown Editor
    Fully responsive, feature-rich, WYSIWYG + Markdown editor

  • Dark/Light Mode
    Matches your style with customizable themes.

  • MIT Licensed
    Completely open source for personal or commercial use.


🚀 Getting Started

1. Clone the Repository

git clone https://github.com/<your-username>/yellow-pages.git
cd yellow-pages

Note: Run the server.ts separately from the docusaurus build to make sure the File Save Functionality works.

Images

Landing Page

image

Frontpage

image

Editor

image

About

A FOSS Self Hosted Documentation Platform with built-in Markdown Editor

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages