moqui-site

Static HTML site for moqui.org. Replaces the older moqui-org Moqui component. Hosted as a GitHub Pages site and (after cutover) fronted by Cloudflare on the apex domain.

No build step. Pages are HTML at the repository root. Shared header and footer are injected by /js/site.js. Third-party libraries are loaded from cdnjs, not vendored.

Local preview

From the repository root (root-absolute URLs need a server, not file://):

python3 serve.py

Then open http://127.0.0.1:8080/ . serve.py mirrors GitHub Pages: missing extensionless paths are served from 404.html, so /docs/framework loads the documentation viewer.

Plain python3 -m http.server also works for real files, but /docs/{space}/{page} will not.

Layout

Path	Role
index.html, framework.html, mantle.html, applications.html, addons.html, service.html	Marketing / directory pages
css/site.css, js/site.js	Theme and shared chrome
docs/	Markdown documentation viewer
docs/manifest.json	Space list and page tree (GitHub Pages cannot list directories)
docs/md/{space}/	Markdown files fetched and rendered in the browser
docs/attachment/{wikiPageId}/	Wiki images and diagrams (/docs/attachment/... URLs)
scripts/import_wiki.py	Re-import from the live HiveMind wiki
javadoc/	Drop generated Javadoc / Groovydoc here (index.html is a placeholder until then)
xsd/	XML schemas, same /xsd/... URLs as the previous site
img/	Logo and related images
CNAME	moqui.org
.nojekyll	Stop Jekyll from skipping files

Documentation viewer

/docs/ is a client-side viewer (marked + DOMPurify + highlight.js). Wiki URLs such as /docs/framework/Quick+Tutorial map to docs/md/framework/Quick Tutorial.md. Nested wiki paths become nested directories (Data and Resources/The Entity Facade.md next to Data and Resources.md). [TOC] / [TOC levels=2-4] is expanded in the browser.

The four public spaces (Community, Framework, Mantle, Applications) were imported from the live HiveMind wiki. Three older Framework pages were Confluence wiki markup and converted to Markdown; the rest were already Markdown.

To refresh from moqui.org (read-only exporter account):

MOQUI_WIKI_USER=exporter MOQUI_WIKI_PASSWORD='...' python3 scripts/import_wiki.py

The importer reads page lists from /m/alldocs/{space}, source from /apps/hm/EditWikiPage (the /qapps shell has no textarea until JavaScript runs), and attachments from /docs/attachment/{wikiPageId}/{filename}. Fetches are cached under /tmp/moqui-wiki-import; --convert-only rebuilds markdown from that cache.

CDN pins

Loaded from cdnjs with Subresource Integrity:

• Font Awesome 7.3.1
• marked 18.0.10
• DOMPurify 3.4.14
• highlight.js 11.11.2 (github-dark theme, extra Groovy language)

GitHub Pages and Cloudflare

Enable Pages from the master branch, site root. CNAME is already moqui.org.

At DNS cutover, point Cloudflare at this Pages origin and add:

• 301 /m/docs/* → /docs/*
• 301 /m/alldocs → /docs/?view=all
• Rewrite (not redirect) /docs/{space}/* to /docs/index.html when the request is not an existing file (.md, .json, .js). GitHub Pages already serves 404.html for those paths; a Cloudflare rewrite can turn the status into 200.
• Keep /xsd/* as static files.

Do not flip the live domain until this site is reviewed.

Not in this site

• Full-text search (was Elasticsearch on the old site)
• HiveMind / issue tracking / login hosted on moqui.org (use GitHub and the Forum; demos remain on demo.moqui.org)

Directory listings (add-ons, service providers) are updated by pull request to this repository.