Skip to content

README.md

Latest commit

 

History

History
43 lines (30 loc) · 1.19 KB

README.md

File metadata and controls

43 lines (30 loc) · 1.19 KB
Raw

Elementeer Documentation

Note

Public mirror. The canonical repository is hosted on our self-hosted git. This GitHub copy is a read-only mirror kept in sync for visibility and installation. Bug reports are welcome via Issues; pull requests are applied upstream and synced back here.

Public, user-facing documentation for the Elementeer agent-native Elementor extension — built with MkDocs Material.

Site: docs.elementeer.xyz

Local development

pip install mkdocs mkdocs-material
mkdocs serve

Build

mkdocs build --clean --strict
# Output in site/

Deploy

Push to main triggers the GitHub Actions deploy workflow, which builds and publishes to GitHub Pages behind Cloudflare.

Structure

  • mkdocs.yml — Site configuration and navigation
  • docs/ — All Markdown content
  • docs/assets/ — Brand CSS, logos, favicon

Contributing

Internal contributions happen on the canonical Forgejo repo (git.langevc.com/elementeer/elementeer-docs). GitHub is a read-only mirror. See the Elementeer Internal Docs for maintainer guidelines.