🗂️ Tools, Platforms & Infrastructure · View mindmap

Markdown Guide

Basics

• Syntax: Simple formatting using symbols like #, *, -, etc.
• Headers: # for largest, ###### for smallest.
• Lists: - for unordered, 1. for ordered.
• Links: [text](url) or WikiLink for internal links.
• Images: ![alt text](image url).

Advanced Features

• Tables: Use | for columns and --- for headers.
• Code Blocks: ```language ``` for syntax highlighting.
• Footnotes: [^1] with [^1]: text at the bottom.
• Blockquotes: > for quoted text.

Integration with Tools

• Obsidian: Supports WikiLink for internal linking.
• GitHub: Renders markdown natively.
• Agentic RAG Systems: Can process markdown for documentation.

AI Agent Documentation Automation

• OpenWiki: An open-source CLI agent from LangChain designed to simplify the generation and maintenance of documentation for codebases, specifically tailored for AI agents.
  • See detailed notes: OpenWiki: Automated Open-Source CLI for AI Agent Documentation
  • Source: OpenWiki: Automated Open-Source CLI for AI Agent Documentation

Related Concepts

• agentic-rag
• azure-ai
• tutorial