[Docs] Dynamic example generation

Author: r0x0r

.gitignore

@@ -21,3 +21,4 @@ __pycache__
 .python-version
 .venv/
 _version.py
+docs/examples/*

docs/.vuepress/config.js

@@ -1,3 +1,8 @@
+const dirTree = require('directory-tree');
+const path = require('path');
+
+const examples = dirTree(path.join(__dirname, '../examples'), {extensions:/\.md/});
+
 module.exports = {
   title: 'pywebview',
   description: 'Build GUI for your Python program with JavaScript, HTML, and CSS',
@@ -10,6 +15,7 @@ module.exports = {
       }
     }
   },
+  port: 8082,
   themeConfig: {
     repo: 'r0x0r/pywebview',
     docsDir: 'docs',
@@ -51,46 +57,9 @@ module.exports = {
           ]
         }
       ],
-      '/examples/': [
-        'cef',
-        'change_url',
-        'close_confirm',
-        'confirmation_dialog',
-        'cookies',
-        'css_load',
-        'close_confirm',
-        'debug',
-        'destroy_window',
-        'events',
-        'expose',
-        'focus',
-        'frameless',
-        'fullscreen',
-        'get_elements',
-        'get_current_url',
-        'hide_window',
-        'html_load',
-        'js_evaluate',
-        'js_evaluate_async',
-        'js_api',
-        'loading_animation',
-        'links',
-        'localization',
-        'menu',
-        'min_size',
-        'minimize_window',
-        'move_window',
-        'multiple_windows',
-        'open_file_dialog',
-        'open_url',
-        'resize_window',
-        'save_file_dialog',
-        'screens',
-        'toggle_fullscreen',
-        'user_agent',
-        'vibrancy',
-        'window_title_change'
-      ],
+      '/examples/': examples.children
+        .filter(file => path.parse(file.name).name !== 'README')
+        .map(file => path.parse(file.name).name),
 
       '/contributing/': [
         'development',

docs/generate-examples.js

@@ -0,0 +1,66 @@
+const fs = require('fs');
+const path = require('path');
+
+const sourceDirectory = '../examples';
+const outputDirectory = './examples';
+
+if (!fs.existsSync(outputDirectory)) {
+  fs.mkdirSync(outputDirectory);
+}
+
+function extractDescriptionFromPythonCode(code) {
+  const match = code.match(/(['"]{3}[\s\S]*?['"]{3})/);
+
+  if (match) {
+    return match[0].replace(/['"]{3}/g, '').trim();
+  } else {
+    return '';
+  }
+}
+
+function removeExtraLineBreaksFromCodeBlock(code) {
+  return code.replace(/(\r?\n){3,}/g, '\n\n').trim();
+}
+
+
+function removeCommentsFromPythonCode(code) {
+  return code.replace(/(^['"]{3}[\s\S]*?['"]{3})/gm, '').trim();
+}
+
+
+function convertToMarkdown(filePath) {
+  try {
+    const pythonCode = fs.readFileSync(filePath, 'utf8');
+    const description = extractDescriptionFromPythonCode(pythonCode);
+    const codeWithoutComments = removeCommentsFromPythonCode(pythonCode);
+    const codeWithoutExtraLineBreaks = removeExtraLineBreaksFromCodeBlock(codeWithoutComments);
+    const fileName = path.basename(filePath, '.py');
+    const markdownFileName = fileName + '.md';
+    const markdownFilePath = path.join(outputDirectory, markdownFileName);
+    const title = fileName.replace(/_/g, ' ').replace(/\b\w/g, (char) => char.toUpperCase());
+    const markdownContent = `# ${title}\n\n${description}\n\n\`\`\`python\n${codeWithoutExtraLineBreaks}\n\`\`\``;
+    fs.writeFileSync(markdownFilePath, markdownContent);
+    console.log(`Converted ${filePath} to ${markdownFilePath}`);
+  } catch (error) {
+    console.error(`Error converting ${filePath}: ${error.message}`);
+  }
+}
+
+function scanDirectory(directoryPath) {
+  fs.readdir(directoryPath, (err, files) => {
+    if (err) {
+      console.error(`Error reading directory: ${directoryPath}`);
+      return;
+    }
+
+    files.forEach((file) => {
+      const filePath = path.join(directoryPath, file);
+
+      if (file.endsWith('.py')) {
+        convertToMarkdown(filePath);
+      }
+    });
+  });
+}
+
+scanDirectory(sourceDirectory);