The beauty of MarkVault lies in its ability to create a decentralized content ecosystem where both site maintainers and contributors can work efficiently while preserving content across multiple locations. Let's break down the ideal workflow for a website built with MarkVault.
-
Site Maintainer
- Owns and manages the main website
- Reviews and approves content
- Maintains site infrastructure
-
Contributors
- Create and write content
- Maintain local copies of content
- Submit content through Pull Requests
Initial Setup (Site Maintainer)
1. Create Your Site
# Clone MarkVault repository
git clone https://github.com/univault-org/MarkVault.git my-site
# Navigate to the new site
cd my-site
2. Configure Your Site
# Update site metadata
cd site
# Edit configuration files for your needs
3. Deploy
# Push to GitHub
git remote set-url origin https://github.com/YOUR_USERNAME/my-site.git
git push -u origin main
# Connect your domain
# Set up hosting (Github Pages, Vercel, Netlify, etc.)
Content Contribution Flow
For Contributors
- Fork and Clone
# Fork my-site on GitHub
# Then clone your fork
git clone https://github.com/YOUR_USERNAME/my-site.git
cd my-site
- Create Content
# Create a new post
touch content/posts/my-new-post.md
# Write your content in Markdown
# Add necessary frontmatter
- Preview Locally
# Start local server
cd site
pnpm dev # for Next.js
# or
npx serve # for React setup
- Submit Content
# Commit your changes
git add content/
git commit -m "content: add post about..."
git push origin main
# Create Pull Request on GitHub
For Site Maintainers
-
Review Process
- Check submitted Pull Requests
- Review content quality and formatting
- Test content rendering
- Provide feedback if needed
-
Merge Content
- Approve and merge quality content
- Site automatically updates
- Content is now part of the main repository
Benefits of This Workflow
1. Decentralized Content Storage
- Each contributor maintains a complete copy
- Content survives even if main site goes down
- Multiple backups across contributors
2. Quality Control
- Site maintainer reviews all content
- Consistent formatting through PR reviews
- Easy to maintain content standards
3. Collaborative Environment
- Multiple contributors can work simultaneously
- Clear process for submissions
- Easy to track contributions
4. Content Preservation
- Content exists in multiple locations
- Contributors keep their work locally
- Natural backup system
Best Practices
-
For Contributors
- Keep your fork updated
- Test content locally before submitting
- Follow site's content guidelines
- Use clear commit messages
-
For Maintainers
- Provide clear contribution guidelines
- Respond to PRs promptly
- Maintain consistent review standards
- Keep site dependencies updated
Setting Up Contribution Guidelines
Create a CONTRIBUTING.md file in your repository:
# Contributing to [Your Site]
1. Fork the repository
2. Create your content in the content/ directory
3. Test locally
4. Submit a Pull Request
5. Await review and approval
Conclusion
This workflow creates a sustainable, decentralized content ecosystem where:
- Content is preserved across multiple locations
- Quality is maintained through reviews
- Contributors maintain ownership of their content
- Site maintainers keep control of their site
The result is a robust system that benefits everyone involved while ensuring content preservation for the future.
Ready to start your own MarkVault site? Check out our Quick Start Guide or visit the GitHub repository to get started!