Update update_toc.yml #5
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Update Table of Contents | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| branches: | |
| - main | |
| jobs: | |
| update_table_of_contents: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v2 | |
| - name: Set up Node.js | |
| uses: actions/setup-node@v2 | |
| with: | |
| node-version: '20' | |
| - name: Generate Table of Contents | |
| run: | | |
| const fs = require('fs'); | |
| const path = require('path'); | |
| /** | |
| * Generates a table of contents for a given directory. | |
| * @param {string} directory - The directory to generate the table of contents for. | |
| * @returns {string} The generated table of contents. | |
| */ | |
| function generateTableOfContents(directory) { | |
| // Initialize the table of contents with an empty string | |
| let tableOfContents = ""; | |
| /** | |
| * Traverses the directory recursively and generates the table of contents. | |
| * @param {string} currentPath - The current path being traversed. | |
| * @param {number} depth - The depth of the current path. | |
| */ | |
| function traverseDirectory(currentPath, depth) { | |
| // Get the files in the current directory | |
| const files = fs.readdirSync(currentPath); | |
| // Traverse each file in the directory | |
| for (const file of files) { | |
| // Get the full path of the file | |
| const filePath = path.join(currentPath, file); | |
| // Get the stats of the file | |
| const stats = fs.statSync(filePath); | |
| // If the file is a directory, generate the table of contents recursively | |
| if (stats.isDirectory()) { | |
| // Capitalize the first letter of the directory name | |
| const folderName = file.charAt(0).toUpperCase() + file.slice(1); | |
| // Add the folder name to the table of contents with appropriate indentation | |
| tableOfContents += `${" ".repeat(depth)}- ${folderName}\n`; | |
| // Recursively traverse the directory | |
| traverseDirectory(filePath, depth + 1); | |
| } | |
| // If the file is a JavaScript file, generate a link to it in the table of contents | |
| else if (file.endsWith(".js")) { | |
| // Get the relative path of the file | |
| const relativePath = path.relative(directory, filePath).replace(/\\/g, "/"); | |
| // Add a link to the file in the table of contents with appropriate indentation | |
| tableOfContents += `${" ".repeat(depth)}- [${file}](${relativePath})\n`; | |
| } | |
| } | |
| } | |
| // Start traversing the given directory | |
| traverseDirectory(directory, 0); | |
| // Return the generated table of contents | |
| return tableOfContents; | |
| } | |
| const directory = "Tutorials"; | |
| const tableOfContents = generateTableOfContents(directory); | |
| const readmePath = path.join(process.env.GITHUB_WORKSPACE, 'README.md'); | |
| let readmeContent = fs.readFileSync(readmePath, 'utf8'); | |
| const tocHeader = "## Table of Contents"; | |
| const tocMarker = "<!-- TABLE_OF_CONTENTS_MARKER -->"; | |
| const updatedReadmeContent = readmeContent.replace(tocMarker, `${tocHeader}\n\n${tableOfContents}\n\n${tocMarker}`); | |
| fs.writeFileSync(readmePath, updatedReadmeContent); |