3.3 KiB
AGENTS.md
Καθοδήγηση για μελλοντικούς agents που εργάζονται σε αυτό το αποθετήριο.
Repository Context
Αυτό είναι το HackTricks Cloud mdBook repository. Το σχετικό main book βρίσκεται στο:
/Users/carlospolop/git/hacktricks
Αλλαγές σε κοινό theme/search behavior συχνά πρέπει να εφαρμόζονται και στα δύο repositories.
Search Index Loading Contract
Το custom search UI βρίσκεται στο:
theme/ht_searcher.js
Μπορεί επίσης να υπάρχει ένα generated copy στο:
book/theme/ht_searcher.js
Αν το production κάνει deploy τον ήδη-built book/ directory, ενημέρωσε και τα δύο copies ή κάνε rebuild το
book πριν το deployment.
Η σειρά φόρτωσης του search index είναι σημαντική και cost-sensitive:
- Φόρτωσε κάθε language-specific και fallback search index από το GitHub repository:
HackTricks-wiki/hacktricks-searchindex - Μόνο αν αποτύχουν όλοι οι GitHub-hosted candidates, κάνε fallback στο same-origin mdBook output.
Μην βάζεις το local /searchindex.js fallback πριν από οποιοδήποτε GitHub-hosted fallback όπως
searchindex-cloud-en.js.gz. Το να σερβίρεται searchindex.js από το cloud.hacktricks.wiki σε production είναι ακριβό.
Για αυτό το repo, το αναμενόμενο local fallback είναι:
/searchindex.js
Το main-book fallback για αυτό το repo είναι:
/searchindex-book.js
Αυτό το αρχείο είναι μόνο fallback. Η primary source πρέπει να παραμένει τα remote
searchindex-<lang>.js.gz και searchindex-cloud-<lang>.js.gz files στο
HackTricks-wiki/hacktricks-searchindex.
Search Index Publishing
Τα workflows που publish encrypted compressed search indexes στο
HackTricks-wiki/hacktricks-searchindex είναι:
.github/workflows/build_master.yml.github/workflows/translate_all.yml
Το generated source file είναι book/searchindex.js. Τα published remote artifact names είναι:
searchindex-cloud-en.js.gzsearchindex-cloud-<lang>.js.gz
Ο browser loader περιμένει τα remote .js.gz files να είναι XOR-encrypted gzip payloads χρησιμοποιώντας το
key που ορίζεται στο theme/ht_searcher.js.
Build And Validation
Κοινά local checks:
node --check theme/ht_searcher.jsmdbook build
Αν το mdbook build αποτύχει, έλεγξε:
hacktricks-preprocessor-error.loghacktricks-preprocessor.log
Editing Notes
- Προτίμησε
rgγια αναζήτηση. - Κράτα το generated
book/output έξω από commits εκτός αν ζητηθεί ρητά. Τα search loader fixes είναι εξαίρεση όταν οι ήδη-built pages πρέπει να διορθωθούν άμεσα. - Αν αλλάζεις shared theme behavior, σύγκρινε και ενημέρωσε το αντίστοιχο αρχείο στο
/Users/carlospolop/git/hacktricks. - Μην επαναφέρεις άσχετες τοπικές αλλαγές.