AI Instruction Markup, inspired by Markdown and Built for Automation
MarkAI is a revolutionary tool that transforms mundane documentation into dynamic, interactive workflows — marrying the clarity of Markdown with the power of AI automation. Whether you're a developer, technical writer, or automation enthusiast, MarkAI turns static documents into engines of productivity and creativity.
"Transform your words into action with MarkAI — where every line of text becomes a spark for innovation!"
- Overview
- Why MarkAI?
- Features
- Getting Started
- Repository Structure
- Contributing
- License
- Acknowledgements & Contact
MarkAI leverages lightweight AI directives embedded in Markdown documents to empower:
- Automated Synchronization: Seamlessly update and synchronize repository data.
- Immutable Command Definitions: Maintain secure, auditable configurations.
- Preemptive Execution: Run critical tasks automatically with priority.
- Elegant Integrations: Enjoy smooth workflows via both a VSCode extension and CLI tools.
Inside this repository, you'll find:
- Specification Files:
- VSCode Extension:
- Located in the
vscode-extension/directory, this extension provides a rich interactive experience for command execution and checkpointing.
- Located in the
- CLI Tools & Reference Implementation:
- Residing under
tools/ma/, including our core engine, plugin management system, and comprehensive tests.
- Residing under
Imagine turning your plain text into a powerhouse of automation. Here's why MarkAI stands out:
- Intuitive & Readable: Write commands directly within your Markdown without sacrificing legibility.
- Secure by Design: Use flags like
locked="true"to safeguard your critical operations. - Innovative Automation: Enable dynamic workflows that respond to changes in real time.
- Future-Proof Architecture: Easily extend functionality through a versatile plugin system.
MarkAI isn't just a tool—it's a new mindset that transforms how you document, collaborate, and execute commands. It's perfect for:
- Developers looking for efficient automation solutions.
- Technical Writers who crave enriched and interactive documentation.
- Teams striving for consistent, error-free processes.
- Automation Enthusiasts eager to harness the intersection of text and intelligent execution.
- AI Instructions: Embed machine-executable commands directly in your documents using the
@ai:tag. - Immutable and Secure: Safeguard operations with secure flags, ensuring your commands are always trusted.
- Remote & Local Execution: Whether operating on your machine or via remote APIs, MarkAI handles it all.
- Extensibility: Expand or tailor functionalities effortlessly through our built-in plugin architecture.
- Real-Time Sync: Automatically keep your automation workflows fresh and up-to-date.
Follow these simple steps to unlock the power of MarkAI:
-
Clone the Repository:
git clone https://github.com/natehouk/markai.git cd markai -
Install Dependencies:
- For the CLI Tool (using Poetry):
cd tools/ma poetry install - For the VSCode Extension:
Open the
vscode-extensionfolder in VSCode and run:npm install
- For the CLI Tool (using Poetry):
-
Usage:
- Command-Line Tool:
Execute commands via:poetry run ma [command]
- VSCode Extension:
Access interactive commands by opening the Command Palette (Ctrl+Shift+P or Cmd+Shift+P) and selecting MarkAI: Checkpoint.
- Command-Line Tool:
MarkAI is designed for clarity, efficiency, and scalability. Here's a quick glance at the repository layout:
README.md- This engaging introduction to MarkAI.MARKAI_V1.0.md&MARKAI_V1.1.md- Detailed specification documents.vscode-extension/- The VSCode extension directory for interactive experiences.tools/ma/- CLI tools, the core engine, the plugin management system, and tests.
Your creativity and passion are what drive MarkAI forward! Contributions are welcome:
- Follow the Coding Standards: Ensure consistency and clarity throughout the project.
- Open an Issue: For any major enhancements or changes, start a discussion first.
- Submit Pull Requests: Please include tests and documentation updates with your contributions.
Let's collaborate to push the boundaries of automated documentation and AI-driven workflows!
This project is licensed under the MIT License.
MarkAI is brought to you with passion by Nathaniel J. Houk and a vibrant community of contributors.
Special thanks to John Gruber, the visionary behind Markdown, whose work continues to inspire innovation and collaboration.
- GitHub: natehouk/markai
- Twitter: @natehouk
- Email: [email protected]
Embrace the future of documentation. Embrace automation. Embrace MarkAI!
© 2025 Nathaniel J. Houk