AiDataGenByLeoFeaturesDocs/README.md

104 lines
3 KiB
Markdown
Raw Permalink Normal View History

2026-04-21 18:53:30 -05:00
<p align="center">
<!-- Banner coming soon -->
</p>
2026-04-21 22:44:33 +00:00
2026-04-21 18:53:30 -05:00
<p align="center">
Interactive web reference for all features supported by the AiDataGenByLeo DSL.
</p>
<p align="center">
2026-04-21 23:55:49 +00:00
<img src="https://img.shields.io/badge/Language-Web%20and%20MQL5-1B6CA8?style=flat-square"/>
<img src="https://img.shields.io/badge/Platform-GitHub%20Pages%20and%20MT5-222222?style=flat-square"/>
2026-04-21 18:53:30 -05:00
<img src="https://img.shields.io/badge/Author-nique__372%20And%20Leo-C9D6DF?style=flat-square"/>
<a href="./LICENSE">
<img src="https://img.shields.io/badge/License-Nique%26Leo%20NL--ND-red.svg"/>
</a>
</p>
---
## Live Docs
**[https://tradesystemsnique.github.io/AiDataGenByLeoFeaturesDocs/](https://tradesystemsnique.github.io/AiDataGenByLeoFeaturesDocs/)**
---
## What Is This?
This repository hosts the interactive feature reference for **[AiDataGenByLeo](https://forge.mql5.io/nique_372/AiDataGenByLeo)** — a DSL-based feature generation system for building AI-powered trading strategies in MetaTrader 5.
The web lets you:
- Browse 85+ built-in features with search and category filters
- Inspect parameters for each feature
- View DSL code examples with syntax highlighting
- Explore `.fgblc` configuration templates (Vector and Matrix)
---
## Repository Structure
```
AiDataGenByLeoFeaturesDocs/
├── MakeDoc.mq5 # MQL5 script — run this to regenerate features.json
└── Doc/ # Web source (served via GitHub Pages)
├── index.html
├── Main.js
├── features.json # Auto-generated by MakeDoc.mq5
├── Fgblc/ # DSL syntax highlighter
└── Examples/ # .fgblc example configurations
```
---
## Requirements
- For project dependencies see `dependencies.json`
- This repo must be cloned into the MetaTrader 5 Shared Projects folder:
`...\MQL5\Shared Projects\AiDataGenByLeoFeaturesDocs`
---
## Installation
- Clone the Git repository into shared projects via CMD
- Contact me on MQL5 (user: nique_372) to be added as a collaborator with your MQL5 nickname (read-only access), which will make the repository automatically appear in your Shared Projects folder
- Or fork the repository
---
## How to use the Web in local
1. Run `MakeDoc.mq5` in MetaTrader 5 — it regenerates `features.json`
2. Open bash in folder docs\:
```bash
python -m http.server 8080
# Open http://localhost:8080
```
---
## Related
- **Main repo:** [AiDataGenByLeo](https://forge.mql5.io/nique_372/AiDataGenByLeo) — DSL parser, feature factory, MQL5 library
- **DSL Reference:** [Parser README](https://forge.mql5.io/nique_372/AiDataGenByLeo/src/branch/main/GenericData/Parser/README.md)
---
## License
**[Read Full License](./LICENSE)**
By downloading or using this repository, you accept the license.
---
## Contact and Support
- **Platform:** [MQL5 Community](https://www.mql5.com/es/users/nique_372)
- **Profile:** https://www.mql5.com/es/users/nique_372/news
- **Issues:** For bug reports or questions
---
2026-04-21 23:56:39 +00:00
**Copyright © 2026 Nique-Leo.**