Skip to content

Commit d37caff

Browse files
committed
Automated scripts reference document generation (CI)
1 parent ed99649 commit d37caff

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

scripts/SCRIPTS.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Script | Directory | Description
3434
| [executeQueryFunctions.sh](./executeQueryFunctions.sh) | | Provides functions to execute Cypher queries using either "executeQuery.sh" or Neo4j's "cypher-shell". |
3535
| [findPathsToScan.sh](./findPathsToScan.sh) | | Finds all files and directories to scan and analyze and provides them as comma-separated list. |
3636
| [importGit.sh](./importGit.sh) | | Coordinates the import of git data from the given --source directory where one ore more git repositories are located and the value of the environment variable IMPORT_GIT_LOG_DATA_IF_SOURCE_IS_PRESENT. |
37-
| [embedMarkdownIncludes.sh](./markdown/embedMarkdownIncludes.sh) | markdown | Processes a template_markdown_file markdown file, replacing placeholders like "<!-- include:intro.md -->" with the contents of the specified markdown files. The files to include needs to be in the "includes" subdirectory. |
37+
| [embedMarkdownIncludes.sh](./markdown/embedMarkdownIncludes.sh) | markdown | Processes template markdown (sysin) replacing placeholders like "<!-- include:intro.md -->" or "<!-- include:intro.md\|fallback.md -->" with the contents of the specified markdown files. The files to include needs to be in the "includes" subdirectory. |
3838
| [formatQueryResultAsMarkdownTable.sh](./markdown/formatQueryResultAsMarkdownTable.sh) | markdown | Takes the input stream (Cypher query result in JSON format) and formats it as a Markdown table. |
3939
| [testEmbedMarkdownIncludes.sh](./markdown/testEmbedMarkdownIncludes.sh) | markdown | Tests template processing for markdown by embedding includes. |
4040
| [testFormatQueryResultAsMarkdownTable.sh](./markdown/testFormatQueryResultAsMarkdownTable.sh) | markdown | Tests formatting of Cypher query results as Markdown table. |
@@ -72,6 +72,7 @@ Script | Directory | Description
7272
| [CsvReports.sh](./reports/compilations/CsvReports.sh) | compilations | Runs all CSV report scripts (no Python and Chromium required). |
7373
| [DatabaseCsvExportReports.sh](./reports/compilations/DatabaseCsvExportReports.sh) | compilations | Exports the whole graph database as a CSV file using the APOC procedure "apoc.export.csv.all" |
7474
| [JupyterReports.sh](./reports/compilations/JupyterReports.sh) | compilations | Runs all Jupyter Notebook report scripts. |
75+
| [MarkdownReports.sh](./reports/compilations/MarkdownReports.sh) | compilations | Runs all Markdown report scripts (no Chromium required, no Python required). |
7576
| [PythonReports.sh](./reports/compilations/PythonReports.sh) | compilations | Runs all Python report scripts (no Chromium required). |
7677
| [VisualizationReports.sh](./reports/compilations/VisualizationReports.sh) | compilations | Runs all Visualization reports. |
7778
| [resetAndScan.sh](./resetAndScan.sh) | | Deletes all data in the Neo4j graph database and rescans the downloaded artifacts to create a new graph. |

0 commit comments

Comments
 (0)