mirror of
https://codeberg.org/vegvisir/website.git
synced 2025-09-14 00:43:42 +02:00
vlw
e5a0a8169c
First (rushed 😦) release of the Vegvisir website. Reviewed-on: https://codeberg.org/vegvisir/website/pulls/1 Co-authored-by: vlw <victor@vlw.se> Co-committed-by: vlw <victor@vlw.se>
82 lines
No EOL
2.6 KiB
PHP
82 lines
No EOL
2.6 KiB
PHP
<?= VV::include("modules/snippet/Snippet.php") ?>
|
|
<?php // General information ?>
|
|
<section class="md">
|
|
<container>
|
|
<p>(Vegvisir 2, Vegvisir 3)</p>
|
|
<h1><code>VV::css()</code></h1>
|
|
<p>Import and minify a CSS file.</p>
|
|
<p>The syntax is identical to <a href=""><code>VV::js()</code></a>, and <a href=""><code>VV::embed()</code></a>.</p>
|
|
</container>
|
|
</section>
|
|
<section class="md">
|
|
<container>
|
|
<h1>Description</h1>
|
|
<?= Snippet::put("docs/API/PHP/VV/css/description", Snippet::PHP) ?>
|
|
<p><code>VV::css()</code> imports and minifies a CSS styleheet file and returns it as a string.</p>
|
|
</container>
|
|
</section>
|
|
|
|
<?php // Method parameters ?>
|
|
<section class="md">
|
|
<container>
|
|
<h2>Parameters</h2>
|
|
</container>
|
|
</section>
|
|
<section class="md inset">
|
|
<container>
|
|
<h3><code>pathname</code></h3>
|
|
<p>Path to a CSS stylesheet file to import relative from <a href="">project root</a>.</p>
|
|
<details>
|
|
<summary>Example</summary>
|
|
<?= Snippet::put("docs/API/PHP/VV/css/0", Snippet::PHP) ?>
|
|
</details>
|
|
</container>
|
|
</section>
|
|
<section class="md inset">
|
|
<container>
|
|
<h3><code>relative</code></h3>
|
|
<p>Path provided to <a href=""><code>pathname</code></a> will be a relative when this parameter is <code>true</code> (default). Set to <code>false</code> to make path absolute.</p>
|
|
<details>
|
|
<summary>Example</summary>
|
|
<?= Snippet::put("docs/API/PHP/VV/css/1", Snippet::PHP) ?>
|
|
</details>
|
|
</container>
|
|
</section>
|
|
|
|
<?php // Method return values ?>
|
|
<section class="md">
|
|
<container>
|
|
<h2>Return values</h2>
|
|
</container>
|
|
</section>
|
|
<section class="md inset">
|
|
<container>
|
|
<h3><code>string</code></h3>
|
|
<p>A string containing minified CSS. Please note that <a href="https://www.php.net/manual/en/reserved.constants.php#constant.php-eol">linebreaks</a> are preserved.</p>
|
|
<p>Will return an empty string if the path provided to <a href=""><code>pathname</code></a> is not a valid CSS stylesheet file, or if it failed to import.</p>
|
|
<details>
|
|
<summary>Example</summary>
|
|
<?= Snippet::put("docs/API/PHP/VV/css/2", Snippet::PHP) ?>
|
|
</details>
|
|
</container>
|
|
</section>
|
|
|
|
<?php // Examples ?>
|
|
<section class="md">
|
|
<container>
|
|
<h1>Examples</h1>
|
|
</container>
|
|
</section>
|
|
<section class="md inset">
|
|
<container>
|
|
<h2>Basic usage</h2>
|
|
<p>Let's take the following CSS stylesheet file and put it into a page.</p>
|
|
<?= Snippet::put("docs/API/PHP/VV/css/example-1-0", Snippet::CSS) ?>
|
|
<?= Snippet::put("docs/API/PHP/VV/css/example-1-1", Snippet::PHP) ?>
|
|
<p>By using <code>VV::css()</code> inside a <code class="tag">style</code>, we've enabled this stylesheet for that specific page.</p>
|
|
</container>
|
|
</section>
|
|
|
|
<?php // Contribute ?>
|
|
|
|
<?= VV::shell("shells/docs") ?>
|