# 🌊 OntoWave - Interactive Documentation Framework **OntoWave** is a powerful, zero-config framework that transforms your static documentation into an interactive website with just one script include! 🌐 **Visit**: [ontowave.org](https://ontowave.org) for complete documentation and live examples. ## ⚡ Quick Start ### CDN Integration (Recommended) ```html My Documentation ``` ### NPM Installation ```bash npm install ontowave ``` ```javascript import 'ontowave'; // OntoWave automatically initializes ``` ## ✹ Key Features - 🚀 **Zero Configuration** - Works out of the box - 🌍 **Multilingual Support** - Built-in French/English interface - 🎹 **Syntax Highlighting** - Prism.js integration - 📊 **Mermaid Diagrams** - Automatic diagram rendering - đŸ“± **Responsive Design** - Mobile-optimized interface - 🔍 **Smart Navigation** - Hash-based routing - ⚙ **Configurable** - Optional JSON configuration - 📩 **Self-contained** - No external dependencies ## ïżœ Configuration (Optional) OntoWave works without configuration, but you can customize it: ```html ``` ## 🎹 Support Diagrammes ## 📊 Diagram Support ### Mermaid Diagrams ````mermaid graph TD A[Start] --> B[Process] B --> C[End] ```` ### Code Highlighting ```javascript // Automatic syntax highlighting with Prism.js const config = { locales: ['en', 'fr'], theme: 'auto' }; ``` ## 📩 Package Size - **66KB minified** - Complete framework - **18KB gzipped** - Optimized delivery - **Zero dependencies** - Self-contained ## 🔗 Learn More - 📖 **Complete Documentation**: [ontowave.org](https://ontowave.org) - 🚀 **Live Examples**: Visit the website for interactive demos - 🐛 **Issues & Support**: [GitHub Issues](https://github.com/stephanedenis/OntoWave/issues) - 📩 **NPM Package**: [npmjs.com/package/ontowave](https://www.npmjs.com/package/ontowave) ## 🌍 Multilingual Support OntoWave includes built-in support for multilingual documentation: - **English/French interface** out of the box - **Language switching** with preserved state - **Configurable locales** via `OntoWaveConfig` ## đŸ€ Contributing We welcome contributions! Please visit [ontowave.org](https://ontowave.org) for development guidelines and contribution instructions. --- ## 📄 License Released under CC BY-NC-SA License - see [ontowave.org](https://ontowave.org) for details. **Created by StĂ©phane Denis** - Making documentation interactive and beautiful! 🌊 ``` ## 📩 Taille - **12KB minifiĂ©** - **4KB gzippĂ©** - **ZĂ©ro dĂ©pendance** ## 🔗 Liens Utiles - [Documentation dĂ©taillĂ©e](README-PACKAGE.md) - [GitHub Repository](https://github.com/stephanedenis/OntoWave) - [Package NPM](https://www.npmjs.com/package/ontowave) --- ## đŸ› ïž DĂ©veloppement Local (version complĂšte) Pour contribuer au dĂ©veloppement d'OntoWave: ```bash npm install npm run dev ``` **DĂ©ploiement:** ```bash npm run build npm run preview ``` ### Architecture - `dist/ontowave.js`: Package distributable principal - `dist/ontowave.min.js`: Version minifiĂ©e pour production ## 📄 License Released under CC BY-NC-SA License - see [ontowave.org](https://ontowave.org) for details. **Created by StĂ©phane Denis** - Making documentation interactive and beautiful! 🌊 ### IntĂ©gration submodules Publiez/recopiez vos sous-modules vers des rĂ©pertoires montĂ©s comme racines de `config.json` (ex: `RESEARCH/`). L'app les servira tels quels et gĂ©rera les liens `.md` → routes `#/
`. ### GitHub Pages et DNS 1) **Configuration Pages** - Repo ➜ Settings ➜ Pages ➜ Build and deployment: Deploy from a branch - Branch: `main`, Folder: `/docs` - Custom domain: `ontowave.dev` (ou votre domaine) 2) **DNS requis cĂŽtĂ© registrar** - CrĂ©ez des enregistrements A pour l'apex/root: - `@` ➜ 185.199.108.153 - `@` ➜ 185.199.109.153 - `@` ➜ 185.199.110.153 - `@` ➜ 185.199.111.153 - Et/ou un CNAME pour sous-domaine: - `www` ➜ `.github.io` --- **CrĂ©Ă© pour simplifier la documentation !** 🌊 ## Structure - `public/config.json`: configuration des racines de contenu (par dĂ©faut `content/`). - `content/`: vos fichiers Markdown (exemples fournis). - `src/`: app Vite (TypeScript), router et rendu Markdown. - `tools/build-sitemap.mjs`: gĂ©nĂšre `public/sitemap.json` en scannant les racines. ## IntĂ©gration submodules Publiez/recopiez vos sous-modules vers des rĂ©pertoires montĂ©s comme racines de `config.json` (ex: `RESEARCH/`). L’app les servira tels quels et gĂ©rera les liens `.md` → routes `#/
`. ## GitHub Pages et DNS (custom domain) 1) Config Pages - Repo ➜ Settings ➜ Pages ➜ Build and deployment: Deploy from a branch - Branch: `main`, Folder: `/docs` - Custom domain: `ontowave.dev` (ou votre domaine). Le fichier `docs/CNAME` est pris en compte. 2) DNS requis cĂŽtĂ© registrar - CrĂ©ez un enregistrement A (si apex/root): - `@` ➜ 185.199.108.153 - `@` ➜ 185.199.109.153 - `@` ➜ 185.199.110.153 - `@` ➜ 185.199.111.153 - Et/ou un CNAME (pour un sous-domaine, ex: `www`): - `www` ➜ `.github.io` (ex: `stephanedenis.github.io`) 3) HTTPS - Dans Settings ➜ Pages, cochez "Enforce HTTPS" aprĂšs propagation DNS. 4) Domaines alternatifs (.net/.com, www) - Vous avez indiquĂ© que `ontowawe.net`, `www.ontowave.net`, `ontowave.com` et `www.ontowave.com` pointent en CNAME vers `stephanedenis.github.io`. - Pour un domaine canonique unique, ce projet utilise `ontowave.com` (voir `docs/CNAME`). - Recommandation: laissez GitHub Pages gĂ©rer les redirections HTTPS (une seule entrĂ©e CNAME cĂŽtĂ© Pages). Si besoin, une redirection cĂŽtĂ© client existe dans `index.html` pour les hĂŽtes alternatifs vers `https://ontowave.com`. 5) Validation / Ă©tat actuel - Projet configurĂ© pour produire `docs/` (Vite outDir) et inclut `docs/CNAME` et `docs/.nojekyll`. - Reste Ă  faire cĂŽtĂ© compte GitHub: activer Pages sur `main/docs` et saisir le domaine custom `ontowave.com`. - Reste Ă  faire cĂŽtĂ© registrar: crĂ©er les enregistrements A/CNAME ci-dessus vers GitHub Pages. 6) DĂ©ploiement - Chaque push sur `main` met Ă  jour `docs/`; Pages sert la derniĂšre version. - Option: ajouter un workflow d’upload artefact si vous souhaitez conserver un build de rĂ©fĂ©rence. *** ## Mode sans serveur (file://) — Standalone Ouvrez directement le site depuis un fichier HTML local (sans serveur HTTP): 1) GĂ©nĂ©rez la version autonome qui embarque config et contenus: ```bash npm run build:standalone ``` 2) Ouvrez `docs/standalone/index.html` dans le navigateur (schĂ©ma `file://`). Notes: - Le bundle embarquĂ© (`window.__ONTOWAVE_BUNDLE__`) inclut `public/config.json`, `public/{sitemap.json,nav.yml,pages.txt,search-index.json}` si prĂ©sents, ainsi que tout `content/`. - Le runtime tente d’abord l’accĂšs embarquĂ©, puis retombe sur `fetch` rĂ©seau. Ainsi, file:// fonctionne mĂȘme sans serveur. - La recherche avancĂ©e nĂ©cessite un `search-index.json` prĂ©construit; sinon, mode minimal (titres). Limitations MVP: - Pas d’indexation de recherche (prĂ©vue via `sitemap.json` + Web Worker elasticlunr). - SĂ©curitĂ© XSS: le contenu est supposĂ© de confiance. Ajoutez DOMPurify si nĂ©cessaire. ## Recherche (SPA, opt-in) - L’index est inactif par dĂ©faut si aucun `search-index.json` n’est prĂ©sent (Ă  cĂŽtĂ© d’`index.html`). - Activez-le via le panneau « Options » (mini-menu flottant), importez un `pages.txt` (liste de chemins `.md` relatifs aux racines), laissez l’index se construire, puis exportez `search-index.json`. - En build, `npm run pageslist` gĂ©nĂšre automatiquement `public/pages.txt`; vous pouvez ensuite ouvrir le site, activer l’index, puis exporter. - La recherche privilĂ©gie la langue courante (prĂ©fixe `#/fr/` ou `#/en/`), avec repli inter-langue si aucun rĂ©sultat. ### DĂ©ploiement « copie statique » Pour un usage sans pipeline (copie d’`index.html` + `assets` + `config.json` + contenus): - Placez `config.json`, `nav.yml` (optionnel) et `sitemap.json`/`pages.txt` Ă  cĂŽtĂ© d’`index.html`. - Si vous ne voulez pas d’indexation en ligne, exportez `search-index.json` depuis le panneau Options et copiez-le avec le site. - Optionnel: rĂ©duisez l’habillage via `ui` dans `public/config.json`: - `"ui": { "minimal": true }` pour masquer header/sidebar/toc/footer. - Ou au dĂ©tail: `header:false`, `sidebar:false`, `toc:false`, `footer:false`, `menu:false`.