How tibyandy/hakoniwa-explorer-plus-guide works
Purpose and Delivery
This repository is a static, GitHub Pages-hosted reference guide for *Hakoniwa Explorer Plus*. Jekyll renders Markdown content and shared HTML includes into the published guide; there is no application backend or build service represented in the tree.
Primary public entry points:
• index.md — guide landing page.
• topics.md — topic navigation.
• 404.md — GitHub Pages not-found page.
• db/db.html — interactive database page.
Jekyll Site Shell
Jekyll/GitHub Pages provides the rendering runtime and site configuration:
• _config.yml — Jekyll site configuration.
• _includes/head.html — shared document head, likely stylesheet/script inclusion boundary.
• _includes/footer.html — shared footer markup.
• assets/custom.scss — site-wide custom styling.
Markdown pages are source documents; GitHub Pages turns them into static HTML using the configured theme/layout conventions.
Guide Content Domains
The guide is organized as authored Markdown reference sections, with individual pages serving as stable URL endpoints:
• game/map.md — map-oriented guide content.
• game/items.md — item reference.
• game/enemies.md — enemy reference.
• game/bosses.md — boss reference.
• game/shops.md — shop reference.
• game/towns.md — town reference.
• game/places.md — location/place reference.
These pages are primarily content boundaries rather than runtime modules; navigation links connect readers among domains.
Interactive Database Subsystem
A distinct client-side database feature lives under db/:
• db/db.html — database UI host page.
• db/db.js — browser-side database behavior and data/UI control logic.
• db/db.css — database-specific presentation.
• db/db.md — likely documentation or alternate routed entry for the database.
The browser loads the database page and its scoped CSS/JavaScript. db/db.js is the principal dynamic execution entry point in an otherwise static site.
Client-Side Interaction
A repository-root script supports scrolling behavior:
• scroller.js — shared browser-side scrolling/navigation behavior.
• test.html — standalone HTML page, likely used to exercise or validate client-side behavior.
This is a browser-only runtime boundary: scripts execute after static assets are served, without server APIs indicated by the repository.
Publishing and External Dependencies
Infrastructure is GitHub Pages with Jekyll, as identified by the README and _config.yml. The deployed site is hosted at the GitHub Pages URL referenced in README.md.
No database server, API service, authentication provider, package manifest, or CI workflow is present. Content, database logic, styles, and client scripts are all versioned static files. Licensing is Creative Commons BY-SA 4.0 via LICENSE.
Main entry points: db.html Database UI · topics.md Topic navigation · index.md Guide landing · db.md Database documentation
Components 16
Jekyll Site
Static publishing shell.
- GitHub Pages · Publishes the rendered static guide.
- Jekyll renderer · Renders Markdown into static HTML.
- Site configuration
_config.yml - Shared head · Shared asset inclusion boundary.
_includes/head.html - Shared footer
_includes/footer.html - Site styles
assets/custom.scss
Guide Content
Authored reference endpoints.
- Guide landing
index.md - Topic navigation
topics.md - Game reference pages · Map, items, enemies, bosses, shops, towns, and places.
- Not-found page
404.md
Interactive Database
Browser-only database feature.
- Database UI · Interactive database host page.
db/db.html - Database logic · Principal dynamic execution entry point.
db/db.js - Database styles
db/db.css - Database documentation · Alternate database route or documentation.
db/db.md
Client Interaction
Shared browser behavior.
- Scrolling behavior · Shared scrolling and navigation behavior.
scroller.js - Reader browser · Loads static pages and executes client scripts.
Connections 18
- Site configuration → Jekyll renderer: configures
- Jekyll renderer → GitHub Pages: publishes via
- Guide landing → Jekyll renderer: rendered by
- Topic navigation → Jekyll renderer: rendered by
- Game reference pages → Jekyll renderer: rendered by
- Not-found page → Jekyll renderer: rendered by
- Database documentation → Jekyll renderer: rendered by
- Shared head → Jekyll renderer: included in pages
- Shared footer → Jekyll renderer: included in pages
- Site styles → Shared head: loaded from
- GitHub Pages → Reader browser: serves static site
- Guide landing → Topic navigation: guides navigation
- Topic navigation → Game reference pages: links to
- Database UI → Reader browser: loaded in
- Database logic → Database UI: drives UI
- Database styles → Database UI: styles
- Scrolling behavior → Reader browser: executes in
- Database documentation → Database UI: documents or routes to