mkdocs for ATC

I found that the windmill theme is a very fast one.
With the standard set of detection rule paths the complete build only
needs ~20 seconds to build.
This commit is contained in:
Hendrik 2020-10-24 15:58:02 +02:00
parent d361284407
commit a91f93e680
4 changed files with 31 additions and 1 deletions

View File

@ -0,0 +1,2 @@
# ATC

View File

@ -46,6 +46,10 @@ markdown:
@echo "[*] Creating markdown repository and pushing data"
python3 main.py --markdown --auto --init
mkdocs:
@echo "[*] Creating mkdocs site"
mkdocs build
confluence:
@echo "[*] Creating confluence repository and pushing data"
python3 main.py --confluence --auto --init
@ -70,6 +74,7 @@ thehive_templates:
clean:
@echo "[*] Cleaning up..."
@rm -rf ./Atomic_Threat_Coverage
@rm -rf ./site
@rm -f ./analytics/generated/analytics.csv
@rm -f ./analytics/generated/atc_es_index.json
@rm -f ./analytics/generated/pivoting.csv

19
mkdocs.yml Normal file
View File

@ -0,0 +1,19 @@
site_name: ATC
docs_dir: Atomic_Threat_Coverage
site_dir: site/
theme:
name: 'windmill'
repo_url: https://github.com/atc-project/atomic-threat-coverage
# edit_uri: blob/master/docs/
plugins:
- search
- awesome-pages
- exclude:
glob:
- "*DS_Store"
- "*.git"
- "*.idea"
- "thehive_templates"

View File

@ -3,4 +3,8 @@ requests
jinja2
elasticsearch
pytest
stix2
stix2
mkdocs
mkdocs-awesome-pages-plugin
mkdocs-exclude
mkdocs-windmill