Add constant lists to site

Author: burner1024

.gitignore

@@ -5,4 +5,5 @@ node_modules/
 docs/.vitepress/dist
 docs/.vitepress/cache
 docs/functions/
+docs/constants/
 docs/types.md

docs/.vitepress/config.ts

@@ -104,6 +104,19 @@ _paq.push(['enableLinkTracking']);
           { text: "String references", link: "/functions/strref" },
         ],
       },
+      {
+        text: "Constants",
+        items: [
+          { text: "IDS", link: "/constants/ids" },
+          { text: "Spells", link: "/constants/spells" },
+          { text: "Opcodes", link: "/constants/opcodes" },
+          { text: "Opcode Parameters", link: "/constants/opcode-params" },
+          { text: "Offsets", link: "/constants/structures" },
+          { text: "Icons", link: "/constants/icons" },
+          { text: "Scrolls", link: "/constants/scrolls" },
+          { text: "Miscellaneous", link: "/constants/misc" },
+        ],
+      },
     ],
 
     editLink: {

docs/.vitepress/theme/custom.css

@@ -55,10 +55,13 @@ html {
 
 /* -- Tables -- */
 .vp-doc table {
+  display: table;
   width: 100%;
   border-collapse: collapse;
   margin: 1rem 0;
   font-size: 0.9em;
+  table-layout: auto;
+  overflow-x: auto;
 }
 
 .vp-doc th {
@@ -74,10 +77,22 @@ html {
   border: 1px solid var(--vp-c-divider);
 }
 
+/* Code in table cells: allow normal word wrapping */
+.vp-doc td code {
+  white-space: normal;
+  word-break: normal;
+}
+
 .vp-doc tr:hover td {
   background-color: var(--vp-c-bg-soft);
 }
 
+/* -- Feature card links: make them visually distinct -- */
+.VPFeature a {
+  color: var(--vp-c-brand-1);
+  text-decoration: underline;
+}
+
 /* -- Hide markdown horizontal rules (headings provide separation) -- */
 .vp-doc hr {
   margin: 0;

docs/_data/constants.yml

@@ -0,0 +1,100 @@
+# Constant sections for documentation generation.
+# Each entry maps to one or more .tph source files that get combined into a single doc page.
+# "files" paths are relative to project root.
+
+- name: ids
+  title: IDS
+  desc: Named constants for IDS file values (animation IDs, effect IDs, gender, slots, etc.).
+  files:
+    - ids/animate_ids.tph
+    - ids/effect_ids.tph
+    - ids/gender_ids.tph
+    - ids/projectile_ids.tph
+    - ids/slots_ids.tph
+    - ids/types.tph
+
+- name: spells
+  title: Spells
+  desc: Spell resref constants by game.
+  files:
+    - ids/spell_ids_bg2ee.tph
+    - ids/spell_ids_bgee.tph
+    - ids/spell_ids_iwdee.tph
+
+- name: opcodes
+  title: Opcodes
+  desc: Named constants for opcode numbers.
+  files:
+    - misc/opcode.tph
+    - misc/opcode_ee.tph
+
+- name: opcode-params
+  title: Opcode Parameters
+  desc: Named constants for opcode parameter values.
+  files:
+    - opcodes/0_ac_modifier.tph
+    - opcodes/12_damage.tph
+    - opcodes/144_279_button_type.tph
+    - opcodes/146_cast_spell_type.tph
+    - opcodes/17_current_hp_mod_type.tph
+    - opcodes/236_project_image.tph
+    - opcodes/82_script_type.tph
+    - opcodes/mod_type.tph
+
+- name: structures
+  title: Offsets
+  desc: Named offset constants for IE file format structures (ARE, CRE, EFF, ITM, SPL, STO, etc.).
+  files:
+    - structures/are/main.tph
+    - structures/are/container_flags.tph
+    - structures/are/door_flags.tph
+    - structures/are/region_flags.tph
+    - structures/are/region_type.tph
+    - structures/cre/main.tph
+    - structures/cre/flags.tph
+    - structures/eff/main.tph
+    - structures/eff/iesdp.tph
+    - structures/eff2/main.tph
+    - structures/eff2/iesdp.tph
+    - structures/fx/main.tph
+    - structures/fx/iesdp.tph
+    - structures/fx/resist_dispel.tph
+    - structures/fx/saving_throw.tph
+    - structures/fx/target.tph
+    - structures/fx/timing.tph
+    - structures/itm/main.tph
+    - structures/itm/attack_type.tph
+    - structures/itm/damage_type.tph
+    - structures/itm/depletion.tph
+    - structures/itm/header_flags.tph
+    - structures/itm/header_target.tph
+    - structures/itm/iesdp.tph
+    - structures/spl/main.tph
+    - structures/spl/flags.tph
+    - structures/spl/iesdp.tph
+    - structures/spl/spell_form.tph
+    - structures/sto/main.tph
+    - structures/sto/flags.tph
+    - structures/sto/iesdp.tph
+    - structures/sto/item_flags.tph
+    - structures/item_types.tph
+
+- name: icons
+  title: Icons
+  desc: Portrait icon index constants.
+  files:
+    - misc/icons.tph
+
+- name: scrolls
+  title: Scrolls
+  desc: Scroll resref constants.
+  files:
+    - misc/scrolls.tph
+    - misc/scrolls_iwdee.tph
+    - misc/scrolls_protection.tph
+
+- name: misc
+  title: Miscellaneous
+  desc: Secondary type tables and other constants.
+  files:
+    - 2da/sectype.tph

docs/index.md

@@ -16,6 +16,9 @@ hero:
     - theme: alt
       text: Functions
       link: /functions/2da
+    - theme: alt
+      text: Constants
+      link: /constants/ids
     - theme: alt
       text: Types
       link: /types

package.json

@@ -7,8 +7,8 @@
 		"typecheck": "tsc --noEmit",
 		"iesdp-update": "bash scripts/iesdp-update.sh",
 		"test": "vitest run",
-		"build-site": "tsx scripts/jsdoc-to-md.ts && pnpm exec vitepress build docs",
-		"serve": "tsx scripts/jsdoc-to-md.ts && pnpm exec vitepress dev docs"
+		"build-site": "tsx scripts/jsdoc-to-md.ts && tsx scripts/constants-to-md.ts && pnpm exec vitepress build docs",
+		"serve": "tsx scripts/jsdoc-to-md.ts && tsx scripts/constants-to-md.ts && pnpm exec vitepress dev docs"
 	},
 	"dependencies": {
 		"gray-matter": "^4.0.3",