Skip to content

🏁 Getting Started with MarkVault

Welcome to MarkVault, a GitHub-powered blog manager that allows you to write, edit, and sync Markdown (.md) or JSON (.json) files directly with GitHubβ€”without using a database!

This guide will help you set up MarkVault and understand its core workflow.


πŸš€ What is MarkVault?

MarkVault is an open-source blogging tool that stores blog posts directly in a GitHub repository, ensuring version control, collaboration, and easy content management.

πŸ”₯ Why Use MarkVault?

βœ… No Database Required – Your blog posts are stored in GitHub, ensuring security and versioning.
βœ… Fast & Lightweight – No heavy CMS; just a simple Markdown-based workflow.
βœ… GitHub Sync – All blog content is automatically pushed and fetched from a repository.
βœ… Markdown & JSON Support – Write in either format and store your content efficiently.
βœ… Open-Source & Developer-Friendly – Ideal for technical blogs, documentation, and team collaboration.


πŸ› οΈ How MarkVault Works

1️⃣ User creates a blog post using the web-based editor.
2️⃣ Content is saved and pushed to the configured GitHub repository.
3️⃣ MarkVault fetches the latest posts from GitHub dynamically.
4️⃣ Posts are displayed on the website in a clean and readable format.


πŸ“Œ Prerequisites

Before you start, ensure you have:

πŸ”Ή Python 3.10+ installed on your system.
πŸ”Ή A GitHub account with a repository for storing blog content.
πŸ”Ή Git installed for version control operations.
πŸ”Ή A GitHub Personal Access Token (PAT) with repo permissions.


πŸ“₯ Next Steps

Once you're familiar with MarkVault, proceed to:

➑️ Installation Guide – Set up MarkVault on your system.
➑️ Configuration Guide – Configure GitHub integration and environment variables.
➑️ Writing Blogs – Learn how to create and manage blog posts.


πŸ“’ Need Help?

If you have questions or issues, check out the FAQs or visit the Troubleshooting Guide.

πŸš€ Get started with MarkVault today and enjoy a seamless blogging experience!