📝 Writing Blogs with MarkVault
MarkVault makes it easy to create, edit, and publish blog posts directly to your GitHub repository. Follow this guide to start writing and managing your blogs efficiently.
✍️ 1. Creating a New Blog Post
To create a new blog post:
1️⃣ Navigate to the Blog Creation Page:
- Open your browser and go to:
http://127.0.0.1:8000/create/
2️⃣ Fill in the blog details:
- Title: Enter a meaningful title for your blog.
- Content: Write your content in Markdown or plain text.
- Format Choice: Select either Markdown (.md) or JSON (.json) for saving your blog.
3️⃣ Click the Submit button to save and push your blog post to GitHub.
✅ Your blog will be saved in the configured GitHub repository.
📄 2. Viewing All Blogs
To see all blogs stored in your GitHub repository:
-
Open your browser and visit:
http://127.0.0.1:8000/ -
This page will display a list of blogs fetched from GitHub.
- Clicking on a blog title will open its content.
🔄 3. Editing an Existing Blog Post
Currently, MarkVault does not support direct editing.
To update an existing blog post:
1️⃣ Open your GitHub repository where blogs are stored.
2️⃣ Locate the file you want to edit (Markdown or JSON format).
3️⃣ Click the Edit button in GitHub.
4️⃣ Make your changes and commit them.
📌 In future updates, we plan to add an in-app editing feature.
🚀 4. Deleting a Blog Post
Currently, MarkVault does not support direct deletion.
To remove a blog post:
1️⃣ Open your GitHub repository.
2️⃣ Locate the file you want to delete.
3️⃣ Click on the file and select Delete this file.
4️⃣ Commit the change to remove it permanently.
🌟 5. Formatting Your Blogs
Since MarkVault supports Markdown, you can format your blogs easily:
| Feature | Markdown Syntax |
|---|---|
| Headings | # Title / ## Subtitle / ### Heading 3 |
| Bold Text | **Bold** or __Bold__ |
| Italic Text | *Italic* or _Italic_ |
| Lists | - Bullet Point / 1. Numbered List |
| Code Blocks | ```python print("Hello") ``` |
| Links | [Google](https://www.google.com) |
| Images |  |
💡 Using Markdown makes your blogs structured, readable, and easy to export.
🔥 6. Best Practices for Writing Blogs
✅ Use Clear Titles: Make your blog title short and descriptive.
✅ Structure Your Content: Use headings (#), lists (- or 1.), and paragraphs for readability.
✅ Keep It Concise: Avoid unnecessary long paragraphs—break them into sections.
✅ Use Proper Formatting: Markdown helps keep content structured and visually appealing.
✅ Add Relevant Images & Links: Use images and references to enhance the content.
🎯 Next Steps
➡️ FAQs – Find answers to common questions.
➡️ Troubleshooting – Solve potential issues.
➡️ Contributing – Learn how to improve MarkVault.
🆘 Need Help?
For issues, check our GitHub Issues or discuss in our Discussions section.
🚀 Start writing and publishing with MarkVault today!