| <!doctype html> |
| <html class="no-js" lang="en" dir="ltr"> |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="x-ua-compatible" content="ie=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| <title>Apache Theme for ASF Pelican - Apache Infrastructure Website</title> |
| <link href="/css/bootstrap.min.css" rel="stylesheet"> |
| <link href="/css/fontawesome.all.min.css" rel="stylesheet"> |
| <link href="/css/headerlink.css" rel="stylesheet"> |
| <script src="/highlight/highlight.min.js"></script> </head> |
| <body class="d-flex flex-column h-100"> |
| <main class="flex-shrink-0"> |
| <div> |
| |
| <!-- nav bar --> |
| <nav class="navbar navbar-expand-lg navbar-dark bg-dark" aria-label="Fifth navbar example"> |
| <div class="container-fluid"> |
| <a class="navbar-brand" href="/"><img src="/images/feather.png" style="height: 32px;"/> Apache Infrastructure</a> |
| <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarADP" aria-controls="navbarADP" aria-expanded="false" aria-label="Toggle navigation"> |
| <span class="navbar-toggler-icon"></span> |
| </button> |
| |
| <div class="collapse navbar-collapse" id="navbarADP"> |
| <ul class="navbar-nav me-auto mb-2 mb-lg-0"> |
| <li class="nav-item dropdown"> |
| <a class="nav-link dropdown-toggle" href="#" data-bs-toggle="dropdown" aria-expanded="false">About</a> |
| <ul class="dropdown-menu"> |
| <li><a class="dropdown-item" href="/team.html">About the team</a></li> |
| <li><a class="dropdown-item" href="/roundtable.html">The Infrastructure Roundtable</a></li> |
| <li><a class="dropdown-item" href="/blog/">The Infrastructure Blog</a></li> |
| </ul> |
| </li> |
| <li class="nav-item"> |
| <a class="nav-link" href="/policies.html">Policies</a> |
| </li> |
| <li class="nav-item dropdown"> |
| <a class="nav-link dropdown-toggle" href="#" data-bs-toggle="dropdown" aria-expanded="false">Services and Tools</a> |
| <ul class="dropdown-menu"> |
| <li><a class="dropdown-item" href="/services.html">Services and Tools</a></li> |
| <li><a class="dropdown-item" href="/machines.html">Machines and Fingerprints</a></li> |
| <li><a class="dropdown-item" href="https://blocky.apache.org/">Blocky</a></li> |
| <li><a class="dropdown-item" href="https://app.datadoghq.com/account/login?next=%2Finfrastructure">DataDog</a></li> |
| <li><a class="dropdown-item" href="https://whimsy.apache.org/roster/committer/" target="_blank">Committer Search</a></li> |
| </ul> |
| </li> |
| <li class="nav-item dropdown"> |
| <a class="nav-link dropdown-toggle" href="#" data-bs-toggle="dropdown" aria-expanded="false">Documentation</a> |
| <ul class="dropdown-menu"> |
| <li><a class="dropdown-item" href="/doc.html">Contribute</a></li> |
| <li><a class="dropdown-item" href="/infra-volunteer.html">Volunteer with Infra</a></li> |
| <li><a class="dropdown-item" href="/how-to-mirror.html">Become an ASF download mirror</a></li> |
| <li><a class="dropdown-item" href="/hosting-external-agent.html">Host a Jenkins or Buildbot agent</a></li> |
| |
| </ul> |
| </li> |
| <li class="nav-item"> |
| <a class="nav-link" href="/stats.html">Status</a> |
| </li> |
| <li class="nav-item"> |
| <a class="nav-link" href="/contact.html">Contact Us</a> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </nav> |
| |
| |
| <!-- page contents --> |
| <div id="contents"> |
| <div class="bg-white p-5 rounded"> |
| <div class="col-sm-8 mx-auto"> |
| <h1> |
| Apache Theme for ASF Pelican |
| </h1> |
| <p>The Apache Theme, created for use with <a href="asf-pelican.html">ASF-Pelican</a> for project websites, is available at <a href="https://github.com/apache/template-site/tree/main/theme" target="_blank">github.com/apache/template-site/tree/main.theme</a>.</p> |
| <p>It has two types of files:</p> |
| <ul> |
| <li>Page templates</li> |
| <li>CSS stylesheets</li> |
| </ul> |
| <h2>Page templates</h2> |
| <ul> |
| <li>base.html - the main template. Other templates extend this template automatically, including those in the default Pelican theme.</li> |
| <li>page.html - this overrides Pelican's <code>default/simple page.html</code>, which includes <code><h1>{{ page.title }}</h1></code>. which we do not want.</li> |
| </ul> |
| <p>Change <code>base.html</code> as necessary. Add new override templates if you need them.</p> |
| <p>See the <a href="https://docs.getpelican.com/en/latest/themes.html#inheritance" target="_blank">Pelican documentation</a> for information about inheritance from the simple theme.</p> |
| <h2>CSS stylesheets</h2> |
| <p>In this site the css included by <code>base.html</code> is in the <code>content</code> tree. |
| There are site- or template-specific overrides to the stylesheet frameworks, but these are not done as Pelican specifies.</p> |
| <ul> |
| <li><code>styles.css</code> - consists of custom site CSS overrides. Edit as needed. Here we include the CSS for the ASF permalink style. |
| This file is in the same directory as the html and is included inline with <code>{% include "styles.css" %}</code>.</li> |
| </ul> |
| <h2>Page metadata</h2> |
| <p>This theme uses the following metadata:</p> |
| <ul> |
| <li> |
| <p>Title. Used in <code>base.html</code> with <code><title>{{ page.title }}</title></code> to provide the page title.</p> |
| </li> |
| <li> |
| <p>Notice. This is notice text, which is typically a link to the license.</p> |
| </li> |
| </ul> |
| <p><code>{% if page.notice %}<!-- {{ page.notice }} -->{% endif %}</code></p> |
| <ul> |
| <li> |
| <p>License. This is an alternative to Notice.</p> |
| </li> |
| <li> |
| <p>bodytag. This adds attributes to the <code><body></code> element. |
| This is allows the main <code>index.ezmd</code> to have the same template, but with a different layout.</p> |
| </li> |
| </ul> |
| <p><code><body{% if page.bodytag %} {{ page.bodytag }}{% endif %} ></code> </p> |
| <h2>Pelican settings</h2> |
| <p>Manage Pelican settings in the <a href="https://github.com/apache/template-site/blob/main/pelicanconf.yaml" target="_blank">pelicanconf.yaml</a> file at the top level of the template.</p> |
| <p>Some important settings:</p> |
| <div class="highlight"><pre><span></span><code><span class="n">site</span><span class="o">:</span> |
| <span class="w"> </span><span class="n">name</span><span class="o">:</span><span class="w"> </span><span class="n">NAME</span><span class="w"> </span><span class="n">OF</span><span class="w"> </span><span class="n">YOUR</span><span class="w"> </span><span class="n">SITE</span> |
| <span class="w"> </span><span class="n">description</span><span class="o">:</span><span class="w"> </span><span class="n">DESCRIPTION</span><span class="w"> </span><span class="n">OF</span><span class="w"> </span><span class="n">YOUR</span><span class="w"> </span><span class="n">SITE</span> |
| <span class="w"> </span><span class="n">domain</span><span class="o">:</span><span class="w"> </span><span class="n">YOURSITE</span><span class="o">.</span><span class="na">apache</span><span class="o">.</span><span class="na">org</span> |
| <span class="w"> </span><span class="n">logo</span><span class="o">:</span><span class="w"> </span><span class="n">images</span><span class="o">/</span><span class="n">logo</span><span class="o">.</span><span class="na">png</span> |
| <span class="w"> </span><span class="n">repository</span><span class="o">:</span><span class="w"> </span><span class="n">https</span><span class="o">://</span><span class="n">github</span><span class="o">.</span><span class="na">com</span><span class="sr">/apache/YOUR_REPO/blob/main/content/</span> |
| <span class="w"> </span><span class="n">trademarks</span><span class="o">:</span><span class="w"> </span><span class="n">Apache</span><span class="o">,</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">Apache</span><span class="w"> </span><span class="n">feather</span><span class="w"> </span><span class="n">logo</span><span class="o">,</span><span class="w"> </span><span class="n">and</span><span class="w"> </span><span class="s2">"Project"</span><span class="w"> </span><span class="n">are</span><span class="w"> </span><span class="n">trademarks</span><span class="w"> </span><span class="n">or</span><span class="w"> </span><span class="n">registered</span><span class="w"> </span><span class="n">trademarks</span> |
| </code></pre></div> |
| |
| <h2>Pelican theme</h2> |
| <p>This is a <a href="https://docs.getpelican.com/en/latest/themes.html">custom theme</a>. Pelican templates use <a href="https://jinja.palletsprojects.com/en/3.0.x/">Jinja</a>.</p> |
| <hr /> |
| |
| <h3>Pelican variables set in pelicanconf.py</h3> |
| <p><strong>Note</strong>: early users of this template worked with <code>pelicanconf.py</code>, which is not part of the latest release. This information is for their convenience.</p> |
| <div class="highlight"><pre><span></span><code><span class="n">SITENAME</span> <span class="o">=</span> <span class="sa">u</span><span class="s1">'Apache <pmc>'</span> |
| <span class="n">SITEDOMAIN</span> <span class="o">=</span> <span class="s1">'<pmc>.apache.org'</span> |
| <span class="n">SITEURL</span> <span class="o">=</span> <span class="s1">'https://<pmc>.apache.org'</span> |
| <span class="n">SITELOGO</span> <span class="o">=</span> <span class="s1">'https://<pmc>.apache.org/images/logo.png'</span> |
| <span class="n">SITEDESC</span> <span class="o">=</span> <span class="sa">u</span><span class="s1">'<pmc desc>'</span> |
| <span class="n">SITEREPOSITORY</span> <span class="o">=</span> <span class="s1">'https://github.com/apache/<pmc-site>/blob/<branch>/content/'</span> |
| <span class="n">TRADEMARKS</span> <span class="o">=</span> <span class="sa">u</span><span class="s1">'Apache, the Apache feather logo, and <pmc> are trademarks or registered trademarks'</span> |
| <span class="n">CURRENTYEAR</span> <span class="o">=</span> <span class="n">date</span><span class="o">.</span><span class="n">today</span><span class="p">()</span><span class="o">.</span><span class="n">year</span> |
| </code></pre></div> |
| </div> |
| </div> |
| </div> |
| <!-- footer --> |
| <div class="row"> |
| <div class="large-12 medium-12 columns"> |
| <p style="font-style: italic; font-size: 0.8rem; text-align: center;"> |
| Copyright 2024, <a href="https://www.apache.org/">The Apache Software Foundation</a>, Licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.<br/> |
| Apache® and the Apache feather logo are trademarks of The Apache Software Foundation... |
| </p> |
| </div> |
| </div> |
| <script type="application/ecmascript" src="/js/bootstrap.bundle.min.js" integrity="sha384-OERcA2EqjJCMA+/3y+gxIOqMEjwtxJY7qPCqsdltbNJuaOe923+mo//f6V8Qbsw3"></script> </div> |
| </main> |
| <script>hljs.initHighlightingOnLoad();</script> |
| </body> |
| </html> |
