|
| 1 | +<div align="center"> |
| 2 | + |
| 3 | + |
| 4 | +<a href="https://ko-fi.com/francescobianco/goal?g=10"> |
| 5 | +<img src="https://raw.githubusercontent.com/javanile/php-imap2/refs/heads/main/docs/banner.svg" /> |
| 6 | +</a> |
| 7 | + |
| 8 | + |
| 9 | +</div> |
| 10 | + |
| 11 | +--- |
| 12 | + |
| 13 | +# 📚 php-imap2 Documentation Site |
| 14 | + |
| 15 | +This folder contains the official **documentation website** for the [`php-imap2`](https://github.com/javanile/php-imap2) library, powered by **[Just the Docs](https://just-the-docs.github.io/just-the-docs/)**. |
| 16 | + |
| 17 | +The site is built using **Jekyll** and is deployed via GitHub Pages. |
| 18 | + |
| 19 | +--- |
| 20 | + |
| 21 | +## 📦 Contents |
| 22 | + |
| 23 | +| File / Folder | Description | |
| 24 | +|-----------------------|-----------------------------------------------| |
| 25 | +| `index.md` | Homepage of the documentation site | |
| 26 | +| `compatibility.md` | Compatibility notes for PHP versions | |
| 27 | +| `examples.md` | Usage examples and code snippets | |
| 28 | +| `functions.md` | Detailed documentation of IMAP functions | |
| 29 | +| `google-playground.html` | (Experimental) IMAP function playground | |
| 30 | +| `banner.svg` | Banner used in the site layout | |
| 31 | +| `php-imap2-banner-final.svg` | Final version of the banner logo | |
| 32 | +| `logo.png` | Project logo shown in the documentation | |
| 33 | +| `_config.yml` | Jekyll site configuration | |
| 34 | +| `CNAME` | Custom domain name for GitHub Pages | |
| 35 | + |
| 36 | +--- |
| 37 | + |
| 38 | +## 🚀 How to Run Locally |
| 39 | + |
| 40 | +If you want to preview the documentation site locally, make sure you have [Ruby](https://www.ruby-lang.org/) and [Bundler](https://bundler.io/) installed, then run: |
| 41 | + |
| 42 | +```bash |
| 43 | +bundle install |
| 44 | +bundle exec jekyll serve --livereload |
| 45 | +``` |
| 46 | + |
| 47 | +Open [http://localhost:4000](http://localhost:4000) in your browser. |
| 48 | + |
| 49 | +> 💡 This will reflect the exact look and structure of the live documentation site. |
| 50 | +
|
| 51 | +--- |
| 52 | + |
| 53 | +## 🌐 Custom Domain |
| 54 | + |
| 55 | +This documentation site is published at: |
| 56 | + |
| 57 | +``` |
| 58 | +https://php-imap2.javanile.org |
| 59 | +``` |
| 60 | + |
| 61 | +The `CNAME` file ensures the GitHub Pages deployment uses the correct custom domain. |
| 62 | + |
| 63 | +--- |
| 64 | + |
| 65 | +## 🛠 Contributing to the Docs |
| 66 | + |
| 67 | +You're welcome to improve the docs! You can: |
| 68 | + |
| 69 | +- Fix typos or outdated information |
| 70 | +- Add new examples or function documentation |
| 71 | +- Improve styling or navigation |
| 72 | + |
| 73 | +Just open a pull request targeting the `docs/` folder or submit an issue. |
| 74 | + |
| 75 | +--- |
| 76 | + |
| 77 | +## 📸 Preview |
| 78 | + |
| 79 | + |
| 80 | + |
| 81 | +--- |
| 82 | + |
| 83 | +## 📄 License |
| 84 | + |
| 85 | +All documentation content is available under the same license as the main project (MIT). |
0 commit comments