Skip to content

Commit

Permalink
Built site for gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Quarto GHA Workflow Runner committed Nov 15, 2024
1 parent 5d9fb69 commit 8830f28
Show file tree
Hide file tree
Showing 10 changed files with 69 additions and 55 deletions.
2 changes: 1 addition & 1 deletion .nojekyll
Original file line number Diff line number Diff line change
@@ -1 +1 @@
dcb9217f
effa1b18
2 changes: 1 addition & 1 deletion articles/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ <h1 class="title">Articles</h1>

<div class="quarto-listing quarto-listing-container-default" id="listing-aricles">
<div class="list quarto-listing-default">
<div class="quarto-post image-right" data-index="0" data-listing-date-sort="1731628800000" data-listing-file-modified-sort="1731698575440" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="3" data-listing-word-count-sort="478">
<div class="quarto-post image-right" data-index="0" data-listing-date-sort="1731628800000" data-listing-file-modified-sort="1731698863931" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="3" data-listing-word-count-sort="478">
<div class="thumbnail">
<p><a href="../articles/llm-brand-yml-prompt/index.html" class="no-external"></a></p><a href="../articles/llm-brand-yml-prompt/index.html" class="no-external">
<p><img loading="lazy" src="../articles/llm-brand-yml-prompt/feature.webp" class="thumbnail-image"></p>
Expand Down
30 changes: 22 additions & 8 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,20 @@ <h2 class="anchored" data-anchor-id="learn-more">Learn more</h2>
<p>Jump to <a href="./brand/index.html">Structure</a> to learn about the brand.yml syntax and how to write a <code>_brand.yml</code> file.</p>
<p>You can explore some <a href="./inspiration/index.html">inspiring examples of brand guidelines</a> found in the wild.</p>
<p>If you’re a Python developer or are interested in using <code>_brand.yml</code> to adapt a Python package to use brand.yml for theming, check out the <a href="./pkg/py/index.html">brand_yml Python package documentation</a> to get started.</p>
<div class="callout callout-style-default callout-note callout-titled" title="We'd love to hear from you">
<div class="callout-header d-flex align-content-center">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<div class="callout-title-container flex-fill">
We’d love to hear from you
</div>
</div>
<div class="callout-body-container callout-body">
<p>brand.yml is a new project and we’d love to hear from you to decide how the project will evolve. Some fields may change as we learn what works and what doesn’t.</p>
<p>Please reach out to us on the <a href="https://github.com/posit-dev/brand-yml/discussions">discussion forum</a> with any questions, thoughts, or feedback!</p>
</div>
</div>
</section>
<section id="support" class="level2">
<h2 class="anchored" data-anchor-id="support">Support</h2>
Expand Down Expand Up @@ -455,35 +469,35 @@ <h2 class="anchored" data-anchor-id="design">Design</h2>
<section id="user-stories" class="level3">
<h3 class="anchored" data-anchor-id="user-stories">User stories</h3>
<p>Jordan Ellis and Sofia Torres are data scientists at <strong>Genewise Therapeutics</strong>, a biotech company that uses AI to create tailored treatment plans based on personal genetic makeup and biomarkers.</p>
<div class="callout callout-style-default callout-note callout-titled">
<div class="callout-header d-flex align-content-center" data-bs-toggle="collapse" data-bs-target=".callout-1-contents" aria-controls="callout-1" aria-expanded="true" aria-label="Toggle callout">
<div class="callout callout-style-simple callout-none no-icon callout-titled">
<div class="callout-header d-flex align-content-center" data-bs-toggle="collapse" data-bs-target=".callout-2-contents" aria-controls="callout-2" aria-expanded="true" aria-label="Toggle callout">
<div class="callout-icon-container">
<i class="callout-icon"></i>
<i class="callout-icon no-icon"></i>
</div>
<div class="callout-title-container flex-fill">
Jordan Ellis
</div>
<div class="callout-btn-toggle d-inline-block border-0 py-1 ps-1 pe-0 float-end"><i class="callout-toggle"></i></div>
</div>
<div id="callout-1" class="callout-1-contents callout-collapse collapse show">
<div id="callout-2" class="callout-2-contents callout-collapse collapse show">
<div class="callout-body-container callout-body">
<p><strong>Jordan Ellis</strong> is a data scientist with a strong academic background in bioinformatics, in particular biology, genetics and statistical analysis. They frequently collaborate with bioligists and chemists to analyze data and present results in a clear an digestible format.</p>
<p>Jordan uses both R and Python and has recently started using Quarto to create their reports, which they share with non-scientific stakeholders. They noticed that their reports garnered more attention when they started using Quarto, but they suspect that their reports would be even more impactful if they matched the look and feel of the company’s branded reports.</p>
<p>On the other hand, Jordan doesn’t want to spend too much time having to rely on design teams for their reports, which often need to be re-created when data changes. Once, they tried to learn CSS but found it too complex and intimidating to learn in a few hours, so they settled on a Bootswatch theme that’s “close enough” to Genewise’s brand.</p>
</div>
</div>
</div>
<div class="callout callout-style-default callout-note callout-titled">
<div class="callout-header d-flex align-content-center" data-bs-toggle="collapse" data-bs-target=".callout-2-contents" aria-controls="callout-2" aria-expanded="true" aria-label="Toggle callout">
<div class="callout callout-style-simple callout-none no-icon callout-titled">
<div class="callout-header d-flex align-content-center" data-bs-toggle="collapse" data-bs-target=".callout-3-contents" aria-controls="callout-3" aria-expanded="true" aria-label="Toggle callout">
<div class="callout-icon-container">
<i class="callout-icon"></i>
<i class="callout-icon no-icon"></i>
</div>
<div class="callout-title-container flex-fill">
Sofia Torres
</div>
<div class="callout-btn-toggle d-inline-block border-0 py-1 ps-1 pe-0 float-end"><i class="callout-toggle"></i></div>
</div>
<div id="callout-2" class="callout-2-contents callout-collapse collapse show">
<div id="callout-3" class="callout-3-contents callout-collapse collapse show">
<div class="callout-body-container callout-body">
<p><strong>Sofia Torres</strong> leads a team of data scientists, including Jordan, at Genewise. She’s noticed that Jordan isn’t the only person on their small team who could benefit from branded reporting. She has been considering talking to a designer she knows on the marketing department, but it’s been hard to coordinate a time to meet and the designer sounded confused when he heard about Quarto.</p>
<p>Today, Sofia was copied on emails from two of her reports who each used Quarto to create attached reports. But when she opened the reports, she was a little embarrassed that her team had sent out two reports with wildly different styles.</p>
Expand Down
12 changes: 6 additions & 6 deletions inspiration/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ <h1 class="title">Inspiration</h1>
<h2 class="anchored" data-anchor-id="company-brand-guidelines">Company Brand Guidelines</h2>
<div id="listing-brand-guidelines" class="quarto-listing quarto-listing-container-grid">
<div class="list grid quarto-listing-cols-3">
<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1731698575456" data-listing-reading-time-sort="3" data-listing-word-count-sort="420">
<div class="g-col-1" data-index="0" data-listing-file-modified-sort="1731698863947" data-listing-reading-time-sort="3" data-listing-word-count-sort="420">
<a href="../inspiration/brand-guidelines/posit/index.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<p class="card-img-top">
Expand All @@ -282,7 +282,7 @@ <h5 class="no-anchor card-title listing-title">
</div>
</a>
</div>
<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1731698575456" data-listing-reading-time-sort="1" data-listing-word-count-sort="198">
<div class="g-col-1" data-index="1" data-listing-file-modified-sort="1731698863947" data-listing-reading-time-sort="1" data-listing-word-count-sort="198">
<a href="../inspiration/brand-guidelines/home-depot/index.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<p class="card-img-top">
Expand All @@ -296,7 +296,7 @@ <h5 class="no-anchor card-title listing-title">
</div>
</a>
</div>
<div class="g-col-1" data-index="2" data-listing-file-modified-sort="1731698575456" data-listing-reading-time-sort="3" data-listing-word-count-sort="404">
<div class="g-col-1" data-index="2" data-listing-file-modified-sort="1731698863947" data-listing-reading-time-sort="3" data-listing-word-count-sort="404">
<a href="../inspiration/brand-guidelines/indeed/index.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<p class="card-img-top">
Expand All @@ -310,7 +310,7 @@ <h5 class="no-anchor card-title listing-title">
</div>
</a>
</div>
<div class="g-col-1" data-index="3" data-listing-file-modified-sort="1731698575460" data-listing-reading-time-sort="3" data-listing-word-count-sort="472">
<div class="g-col-1" data-index="3" data-listing-file-modified-sort="1731698863951" data-listing-reading-time-sort="3" data-listing-word-count-sort="472">
<a href="../inspiration/brand-guidelines/slack/index.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<p class="card-img-top">
Expand All @@ -324,7 +324,7 @@ <h5 class="no-anchor card-title listing-title">
</div>
</a>
</div>
<div class="g-col-1" data-index="4" data-listing-file-modified-sort="1731698575464" data-listing-reading-time-sort="2" data-listing-word-count-sort="313">
<div class="g-col-1" data-index="4" data-listing-file-modified-sort="1731698863955" data-listing-reading-time-sort="2" data-listing-word-count-sort="313">
<a href="../inspiration/brand-guidelines/walmart/index.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<p class="card-img-top">
Expand All @@ -338,7 +338,7 @@ <h5 class="no-anchor card-title listing-title">
</div>
</a>
</div>
<div class="g-col-1" data-index="5" data-listing-file-modified-sort="1731698575448" data-listing-reading-time-sort="2" data-listing-word-count-sort="248">
<div class="g-col-1" data-index="5" data-listing-file-modified-sort="1731698863939" data-listing-reading-time-sort="2" data-listing-word-count-sort="248">
<a href="../inspiration/brand-guidelines/dell/index.html" class="quarto-grid-link">
<div class="quarto-grid-item card h-100 card-left">
<p class="card-img-top"><img src="brand-guidelines/dell/dell-color.svg" alt="Dell Logo" style="height: 150px;" class="thumbnail-image card-img"/></p>
Expand Down
10 changes: 5 additions & 5 deletions pkg/py/Brand.html
Original file line number Diff line number Diff line change
Expand Up @@ -513,7 +513,7 @@ <h4 class="doc-section doc-section-raises anchored" data-anchor-id="raises-1">Ra
</section>
<section id="examples-1" class="level4 doc-section doc-section-examples">
<h4 class="doc-section doc-section-examples anchored" data-anchor-id="examples-1">Examples</h4>
<div id="879d61b5" class="cell" data-execution_count="1">
<div id="8d567c15" class="cell" data-execution_count="1">
<div class="sourceCode cell-code" id="cb5"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> brand_yml <span class="im">import</span> Brand</span>
<span id="cb5-2"><a href="#cb5-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb5-3"><a href="#cb5-3" aria-hidden="true" tabindex="-1"></a>brand <span class="op">=</span> Brand.from_yaml_str(<span class="st">"""</span></span>
Expand All @@ -525,13 +525,13 @@ <h4 class="doc-section doc-section-examples anchored" data-anchor-id="examples-1
<span id="cb5-9"><a href="#cb5-9" aria-hidden="true" tabindex="-1"></a><span class="st"> base: Open Sans</span></span>
<span id="cb5-10"><a href="#cb5-10" aria-hidden="true" tabindex="-1"></a><span class="st">"""</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</div>
<div id="3f1b90e9" class="cell" data-execution_count="2">
<div id="6ad1dd13" class="cell" data-execution_count="2">
<div class="sourceCode cell-code" id="cb6"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a>brand.meta</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-display" data-execution_count="2">
<pre><code>BrandMeta(name=BrandMetaName(full='Brand YAML'))</code></pre>
</div>
</div>
<div id="ff261498" class="cell" data-execution_count="3">
<div id="3d02d3d6" class="cell" data-execution_count="3">
<div class="sourceCode cell-code" id="cb8"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a>brand.color.primary</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-display" data-execution_count="3">
<pre><code>'#ff0202'</code></pre>
Expand All @@ -546,7 +546,7 @@ <h3 class="anchored" data-anchor-id="brand_yml.Brand.model_dump_yaml">model_dump
<p>Write the <a href="../../pkg/py/Brand.html#brand_yml.Brand"><code>brand_yml.Brand</code></a> instance to a string or to a file on disk.</p>
<section id="examples-2" class="level4 doc-section doc-section-examples">
<h4 class="doc-section doc-section-examples anchored" data-anchor-id="examples-2">Examples</h4>
<div id="f191460a" class="cell" data-execution_count="4">
<div id="43be8060" class="cell" data-execution_count="4">
<div class="sourceCode cell-code" id="cb11"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a><span class="im">from</span> brand_yml <span class="im">import</span> Brand</span>
<span id="cb11-2"><a href="#cb11-2" aria-hidden="true" tabindex="-1"></a></span>
<span id="cb11-3"><a href="#cb11-3" aria-hidden="true" tabindex="-1"></a>brand <span class="op">=</span> Brand.from_yaml_str(<span class="st">"""</span></span>
Expand All @@ -561,7 +561,7 @@ <h4 class="doc-section doc-section-examples anchored" data-anchor-id="examples-2
<span id="cb11-12"><a href="#cb11-12" aria-hidden="true" tabindex="-1"></a><span class="st">"""</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</div>
<div class="python-code-preview">
<div id="8d443f95" class="cell" data-execution_count="5">
<div id="9441a64e" class="cell" data-execution_count="5">
<div class="sourceCode cell-code" id="cb12"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb12-1"><a href="#cb12-1" aria-hidden="true" tabindex="-1"></a><span class="bu">print</span>(brand.model_dump_yaml())</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-stdout">
<pre><code>meta:
Expand Down
8 changes: 4 additions & 4 deletions pkg/py/color.html
Original file line number Diff line number Diff line change
Expand Up @@ -396,13 +396,13 @@ <h2 class="anchored" data-anchor-id="referencing-colors-in-the-brands-color-pale
</div>
<p>Once imported via <code>brand_yml.Brand.from_yaml()</code>, you can access the named color palette via <code>brand.color.palette["purple"]</code> and the <code>primary</code> field will be ready for use.</p>
<div class="python-code-preview">
<div id="bded2c24" class="cell" data-execution_count="2">
<div id="33550cc2" class="cell" data-execution_count="2">
<div class="sourceCode cell-code" id="cb5"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a>brand.color.palette[<span class="st">"purple"</span>]</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-display" data-execution_count="2">
<pre><code>'#6339E0'</code></pre>
</div>
</div>
<div id="ffdeb030" class="cell" data-execution_count="3">
<div id="b1ff0e1c" class="cell" data-execution_count="3">
<div class="sourceCode cell-code" id="cb7"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a>brand.color.primary</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-display" data-execution_count="3">
<pre><code>'#6339E0'</code></pre>
Expand All @@ -426,13 +426,13 @@ <h2 class="anchored" data-anchor-id="referencing-colors-in-the-brands-color-pale
</div>
<p>With this Brand YAML, both headings and links will ultimately be styled with the brand’s <code>purple</code> color.</p>
<div class="python-code-preview">
<div id="eafc4912" class="cell" data-execution_count="5">
<div id="ec737f1f" class="cell" data-execution_count="5">
<div class="sourceCode cell-code" id="cb10"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a>brand.typography.headings.color</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-display" data-execution_count="5">
<pre><code>'#6339E0'</code></pre>
</div>
</div>
<div id="a4583c3c" class="cell" data-execution_count="6">
<div id="2972e6d0" class="cell" data-execution_count="6">
<div class="sourceCode cell-code" id="cb12"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb12-1"><a href="#cb12-1" aria-hidden="true" tabindex="-1"></a>brand.typography.link.color</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell-output cell-output-display" data-execution_count="6">
<pre><code>'#6339E0'</code></pre>
Expand Down
Loading

0 comments on commit 8830f28

Please sign in to comment.