vegvisir/README.md
vlw 05219a1294 doc(nit): update Vegvisir "slogan" in README (#67)
It's still pretty bad but as least is makes more sense now

Reviewed-on: https://codeberg.org/vegvisir/vegvisir/pulls/67
Co-authored-by: vlw <victor@vlw.se>
Co-committed-by: vlw <victor@vlw.se>
2025-05-20 16:40:23 +02:00

49 lines
2.1 KiB
Markdown

<p align="center">
<img width="100" src="https://href.vlw.se/vegvisir/logo">
</p>
<h1 align="center">Vegvisir</h1>
<p align="center">Vegvisir is a PHP and JavaScript web navigation framework written as a hobby project.</p>
<p align="center"><a href="https://vegvisir.vlw.se/"><strong>Check out the Vegvisir website for more information</strong></a></p>
<h2 align="center">Key Features</h2>
- **Framework and project**: Vegvisir is kept in a separate directory from your project.
- [**Asset injection**](https://vegvisir.vlw.se/docs/API/PHP/VV/css): Bundle your page CSS and JS into the same HTTP response.
- **Native PHP templating**: Templating with PHP's ["alternative syntax for control structures"](https://www.php.net/manual/en/control-structures.alternative-syntax.php)
- **Soft-navigation**: Automatic soft-navigation between pages and [shells](https://vegvisir.vlw.se/docs/API/PHP/VV/shell).
- **Imports**: [Re-use PHP modules as snippets on multiple pages with imports](https://vegvisir.vlw.se/docs/API/PHP/VV/include).
- **Soft-navigation of any element**: Load pages/modules into a specific HTMLElement with [`targetElement` position syntax](https://developer.mozilla.org/en-US/docs/Web/API/Element/insertAdjacentElement#position).
# Documentation
[You can find documentation on the Vegvisir website](https://vegvisir.vlw.se/docs)
# Support
<table>
<thead>
<tr>
<th rowspan="2">PHP</th>
<th colspan="3">Browsers</th>
</tr>
<tr align="center">
<th>Chromium</th>
<th>Gecko</th>
<th>WebKit</th>
</tr>
</thead>
<tbody>
<tr align="center">
<td><img src="https://href.vlw.se/01956f43-7226-7877-815a-188961d2c548"/></td>
<td><img src="https://href.vlw.se/01956f43-8c0c-7f55-9b51-479a066dda63"/></td>
<td><img src="https://href.vlw.se/01956f43-a385-759c-b7e6-954253d39975"/></td>
<td><img src="https://href.vlw.se/01956f43-b68b-73a0-96b9-3b801a18616e"/></td>
</tr>
<tr>
<td>✅ Version 8.2+</td>
<td>✅ Version 80+</td>
<td>✅ Version 75+</td>
<td>✅ Version 14.1+</td>
</tr>
</tbody>
</table>