π 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!