You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-8Lines changed: 4 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ Seamlessly update code snippets in your **README** files! 🔄📝🚀
11
11
12
12
## 📚 Description
13
13
14
-
**Code Embedder** is a GitHub Action that automatically updates code snippets in your `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.
14
+
**Code Embedder** is a GitHub Action 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.
15
15
16
16
✨ **Key features**
17
17
- 🔄 **Automatic synchronization**: Keep your `README` code examples up-to-date without manual intervention.
@@ -22,7 +22,7 @@ By using **Code Embedder**, you can focus on writing and updating your actual co
22
22
23
23
## 🔍 How it works
24
24
25
-
The action looks for the following sections in the `README` file:
25
+
The action looks for the following sections in the all markdown (`README`) files:
26
26
````md
27
27
```language:path/to/script
28
28
```
@@ -78,18 +78,14 @@ jobs:
78
78
79
79
- name: Run code embedder
80
80
uses: kvankova/code-embedder@v0.2.0
81
-
with:
82
-
readme_paths: README.md README2.md
83
81
env:
84
82
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
85
83
86
84
```
87
85
You need to create a secret with write and repo permissions in the repository settings to pass it as `GITHUB_TOKEN` in the workflow.
88
86
89
-
Use the `readme_paths` input to specify which README files to update. Multiple files can be listed with spaces (e.g. `README.md README2.md`). By default, only `README.md` in the root directory is updated.
90
-
91
87
## 🔬 Under the hood
92
88
This action performs the following steps:
93
-
1. 🔎 Scans through the `README` files to identify referenced script files.
94
-
1. 📝 Extracts the contents from those script files and updates the corresponding code blocks in the `README` files.
89
+
1. 🔎 Scans through the markdown (`README`) files to identify referenced script files.
90
+
1. 📝 Extracts the contents from those script files and updates the corresponding code blocks in the markdown (`README`) files.
95
91
1. 🚀 Commits and pushes the updated documentation back to the repository.
0 commit comments