chiark / gitweb /
README.md: update-readme-toc: add autogeneration warning
authorIan Jackson <ijackson@chiark.greenend.org.uk>
Fri, 19 Jun 2020 17:23:55 +0000 (18:23 +0100)
committerIan Jackson <ijackson@chiark.greenend.org.uk>
Fri, 19 Jun 2020 17:23:55 +0000 (18:23 +0100)
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
README.md
markdown-toc-filter

index ce632da8e6367c570e9c4c7c7da406e47bf18b27..e134d38b248fa30685909afe75f6d1db0581cdf7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -52,6 +52,8 @@ $ nailing-cargo build
 Documentation table of contents
 -------------------------------
 
+<!-- TOC autogenerated by ./markdown-toc-filter, do not edit -->
+
   * [Introduction](#nailing-cargo)
     * [Installing](#installing)
     * [Most basic example usage](#most-basic-example-usage)
index 8bb87f74d34b2d18e39a2556642cd4ff9608c4ac..526275da79b5ff7339bf70a50bec62f962d79c81 100755 (executable)
@@ -35,6 +35,10 @@ if (1..(m/^[A-Z]/ && m/table of contents/i)) {
 }
 
 END {
-  print "\n", @toc, "\n";
+  print <<END, @toc, "\n";
+
+<!-- TOC autogenerated by $0, do not edit -->
+
+END
   print @doc;
 }