website/public/docs/v3.1.4/index.php
vlw 7a8fc36ec0 feat: new website design and update to Vegvisir 3.1 (#2)
Brand new design for the website following the new design language I used for [version 2.0 of my personal website](https://codeberg.org/vlw/vlw.se/releases/tag/2.0.0).

Reviewed-on: https://codeberg.org/vegvisir/website/pulls/2
Co-authored-by: vlw <victor@vlw.se>
Co-committed-by: vlw <victor@vlw.se>
2025-03-05 11:16:54 +00:00

19 lines
No EOL
1.9 KiB
PHP

<?= VV::include("public/docs/v3.1.4/layout") ?>
<main>
<section class="md">
<h1>Introduction</h1>
<p>Vegvisir is a work in progress, based on a framework I developed for a company a few years ago, which in turn was based on a content injector I built for another company. You can read more about the history of this framework on my <a href="https://vlw.se/work/vlw/vegvisir">personal website</a>.</p>
<p>Adding a <a href="https://codeberg.org/vegvisir/vegvisir/releases">Vegvisir version number</a> after "/docs" in the pathname <code>/docs/vX.X.X/example-docs-page</code> lets you read the docs for a specific release.</p>
<?= VV::include("snippets/HTMLCodeDemoElement/HTMLCodeDemoElement?id=docs/v3.1.4/introduction_version") ?>
</section>
<section class="md">
<h1>Work in progress</h1>
<p>This website (and the framework itself) is a work in progress. I apologize for the rushed, incomplete, confusing documentation on this site. I will make an effort to update these pages as best as I can.</p>
</section>
<section class="md">
<h1>The basics</h1>
<p>The simple answer to what Vegvisir does is that it will automatically find and bind navigation handlers for all <code>HTMLAnchorElement</code>s on a website. If the anchor <code>href</code> points to a page on the same origin; a PHP file (containing HTML and native PHP templating) from the website's <code>public_path</code> will be automatically soft-navigated to.</p>
<p>Another thing that Vegvisir lets you do with those soft-navigated pages is to inject and minify assets such as <a href="/docs/v3.1.4/Reference/PHP/VV/css">CSS stylesheets</a>, <a href="/docs/v3.1.4/Reference/PHP/VV/js">JavaScript source files</a>, and other assets that <a href="/docs/v3.1.4/Reference/PHP/VV/embed">output text</a>.</p>
<p>And the last thing that Vegvisir will offer for you is <a href="/docs/v3.1.4/Reference/PHP/VV/include">embeding snippets of PHP code (or another page) into a page</a>.</p>
</section>
</main>