{"repo":"kvankova/code-embedder","free":true,"listed":false,"github":"https://github.com/kvankova/code-embedder","clone":"git clone https://github.com/kvankova/code-embedder.git","description":"Keep your code snippets in README up-to-date!","language":"Python","stars":79,"topics":["code-synchronization","github-action","github-action-docker","github-actions","readme"],"license":"MIT","category":"workflow-automation","readme_excerpt":"Code Embedder Seamlessly update code snippets in your README files! 🔄📝🚀 Description • How it works • Setup - Github Action • Setup - Pre-commit Hook • Examples • Contributing • Development 📚 Description Code Embedder is a GitHub Action and a pre-commit hook that automatically updates code snippets in your markdown ( README ) files. It finds code blocks in your README that reference specific scripts, then replaces these blocks with the current content of those scripts. This keeps your documentation in sync with your code. ✨ Key features - 🔄 Automatic synchronization : Keep your README code examples up-to-date without manual intervention. - 🛠️ Easy setup : Simply add the action to your GitHub workflow / pre-commit hook and format your README code blocks. - 📝 Section support : Update only specific sections of the script in the README . This is language agnostic . - 🧩 Object support : Update only specific objects (functions, classes) in the README . The latest version supports only 🐍 Python objects (other languages to be added soon). By using Code Embedder , you can focus on writing and updating your actual code 💻, while letting the Code-Embedder take care of keeping your documentation current 📚🔄. This reduces the risk of outdated or incorrect code examples in your project documentation. 🔍 How it works The Code Embedder scans markdown files for special tags that specify which parts of your scripts to embed. When it finds these tags, it automatically updates the code ","default_branch":null,"files":null,"tree":[],"storefront":"/r/kvankova","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/kvankova/code-embedder/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}