From 2a4d27e3bb1cd2a16f39ed1278153beabe344bfa Mon Sep 17 00:00:00 2001 From: niclas Date: Tue, 6 Feb 2024 16:16:45 +0100 Subject: [PATCH] Add [script] npm setup --- tools/mkdocs/build.sh | 11 +++++++++- tools/mkdocs/generator.py | 33 ----------------------------- tools/mkdocs/site/package-lock.json | 6 ++++++ 3 files changed, 16 insertions(+), 34 deletions(-) create mode 100644 tools/mkdocs/site/package-lock.json diff --git a/tools/mkdocs/build.sh b/tools/mkdocs/build.sh index 71ff4d3..58919ad 100644 --- a/tools/mkdocs/build.sh +++ b/tools/mkdocs/build.sh @@ -1,6 +1,15 @@ #!/bin/bash +# Check if npm is installed +if ! [ -x "$(command -v npm)" ]; then + echo 'Error: npm is not installed.' >&2 + exit 1 +fi + python3 generator.py -cd site +pushd ./site/docs || exit +npm install +popd || exit +cd ./site/ || exit mkdocs build rsync --include ".*" -v -rz --checksum site/ circl@cppz.circl.lu:/var/www/misp-galaxy.org diff --git a/tools/mkdocs/generator.py b/tools/mkdocs/generator.py index 08243f7..5a0bd9c 100644 --- a/tools/mkdocs/generator.py +++ b/tools/mkdocs/generator.py @@ -10,7 +10,6 @@ import validators CLUSTER_PATH = '../../clusters' SITE_PATH = './site/docs' -# PROJECTS_PATH = './site/projects' FILES_TO_IGNORE = [] # if you want to skip a specific cluster in the generation @@ -279,7 +278,6 @@ class Cluster(): self.entry += f'\n' self.entry += f'??? info "Related clusters"\n' self.entry += f'\n' - # self.entry += f'To see the related clusters, click [here](./{self.galaxie}/{self.uuid}.md).\n' self.entry += f' To see the related clusters, click [here](./relations/{self.uuid}.md).\n' def _get_related_entry(self, relations): @@ -289,9 +287,6 @@ class Cluster(): output += f'| Cluster A | Cluster B | Level {{ .graph }} |\n' output += f'|-----------|-----------|-------|\n' for relation in relations: - # cluster_a_section = relation[0].value.lower().replace(" ", "-").replace("/", "").replace(":", "") - # cluster_b_section = relation[1].value.lower().replace(" ", "-").replace("/", "").replace(":", "") - # Use a unique placeholder for " - " placeholder = "__TMP__" cluster_a_section = (relation[0].value.lower() @@ -386,7 +381,6 @@ def create_pie_chart(title, cakepieces): def get_top_x(dict, x, big_to_small=True): sorted_dict = sorted(dict.items(), key=operator.itemgetter(1), reverse=big_to_small)[:x] - # top_x = [re.sub(r"[^A-Za-z0-9 ]", "", key) for key, value in sorted_dict] top_x = [key for key, value in sorted_dict] top_x = ", ".join(top_x) top_x_values = sorted(dict.values(), reverse=big_to_small)[:x] @@ -451,10 +445,7 @@ def create_statistics(cluster_dict): statistic_output += f' | No. | Cluster | Count {{ .bar-chart }}|\n' statistic_output += f' |----|--------|-------|\n' relation_count_dict_galaxies = {cluster_dict[uuid].value: cluster_dict[uuid].galaxie_file_name for uuid in relation_count_dict.keys()} - print(relation_count_dict_names) - print(relation_count_dict_galaxies) for i, cluster in enumerate(top_25_relation.split(", "), 1): - # statistic_output += f' | {i} | [{cluster}](./{cluster}/index.md) | {top_25_relation_values[i-1]} |\n' cluster_section = cluster_name_to_section(cluster) statistic_output += f' | {i} | [{cluster}](../{relation_count_dict_galaxies[cluster]}/#{cluster_section}.md) | {top_25_relation_values[i-1]} |\n' statistic_output += f'\n' @@ -467,16 +458,10 @@ def create_statistics(cluster_dict): statistic_output += f' |----|--------|-------|\n' synonyms_count_dict_galaxies = {cluster_dict[uuid].value: cluster_dict[uuid].galaxie_file_name for uuid in synonyms_count_dict.keys()} for i, cluster in enumerate(top_synonyms.split(", "), 1): - # statistic_output += f' | {i} | [{cluster}](./{cluster}/index.md) | {top_synonyms_values[i-1]} |\n' cluster_section = cluster_name_to_section(cluster) statistic_output += f' | {i} | [{cluster}](../{synonyms_count_dict_galaxies[cluster]}/#{cluster_section}.md) | {top_synonyms_values[i-1]} |\n' statistic_output += f'\n' - # statistic_output += f'# Empty UUIDs statistics\n' - # statistic_output += f'**Number of empty UUIDs**: {sum(empty_uuids_dict.values())}\n' - # statistic_output += f'\n' - # statistic_output += f'**Empty UUIDs per cluster**: {empty_uuids_dict}\n' - return statistic_output def main(): @@ -503,13 +488,6 @@ def main(): for galaxy in galaxies: galaxy.write_entry(SITE_PATH, cluster_dict) - - # count = 7 - # for galaxy in galaxies: - # galaxy.write_entry(SITE_PATH, cluster_dict) - # count -= 1 - # if count == 0: - # break index_output = create_index(galaxies) statistic_output = create_statistics(cluster_dict=cluster_dict) @@ -522,14 +500,3 @@ def main(): if __name__ == "__main__": main() - - # test = cluster_dict['f0ec2df5-2e38-4df3-970d-525352006f2e'] - # test = cluster_dict['d7247cf9-13b6-4781-b789-a5f33521633b'] - # clusters = test.get_related_clusters() - # print(clusters) - # print(len(clusters)) - # print("```mermaid") - # print(f"graph TD") - # for cluster in clusters: - # print(f"{cluster[0].uuid}[{cluster[0].value}] --- {cluster[1].uuid}[{cluster[1].value}]") - # print("```") diff --git a/tools/mkdocs/site/package-lock.json b/tools/mkdocs/site/package-lock.json new file mode 100644 index 0000000..5f35354 --- /dev/null +++ b/tools/mkdocs/site/package-lock.json @@ -0,0 +1,6 @@ +{ + "name": "site", + "lockfileVersion": 2, + "requires": true, + "packages": {} +}