338 lines
13 KiB
HTML
338 lines
13 KiB
HTML
<!doctype html>
|
|
<html lang="en" class="no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
|
|
<meta name="generator" content="Hugo 0.62.2" />
|
|
|
|
<META NAME="ROBOTS" CONTENT="NOINDEX, NOFOLLOW">
|
|
|
|
|
|
|
|
<link rel="shortcut icon" href="/favicons/favicon.ico" >
|
|
<link rel="apple-touch-icon" href="/kubernetes-operator/favicons/apple-touch-icon-180x180.png" sizes="180x180">
|
|
<link rel="icon" type="image/png" href="/kubernetes-operator/favicons/favicon-16x16.png" sizes="16x16">
|
|
<link rel="icon" type="image/png" href="/kubernetes-operator/favicons/favicon-32x32.png" sizes="32x32">
|
|
<link rel="icon" type="image/png" href="/kubernetes-operator/favicons/android-36x36.png" sizes="36x36">
|
|
<link rel="icon" type="image/png" href="/kubernetes-operator/favicons/android-48x48.png" sizes="48x48">
|
|
<link rel="icon" type="image/png" href="/kubernetes-operator/favicons/android-72x72.png" sizes="72x72">
|
|
<link rel="icon" type="image/png" href="/kubernetes-operator/favicons/android-96x196.png" sizes="96x196">
|
|
<link rel="icon" type="image/png" href="/kubernetes-operator/favicons/android-144x144.png" sizes="144x144">
|
|
<link rel="icon" type="image/png" href="/kubernetes-operator/favicons/android-192x192.png"sizes="192x192">
|
|
|
|
<title>Easy documentation with Docsy | Jenkins Operator</title><meta property="og:title" content="Easy documentation with Docsy" />
|
|
<meta property="og:description" content="The Docsy Hugo theme lets project maintainers and contributors focus on content, not on reinventing a website infrastructure from scratch" />
|
|
<meta property="og:type" content="article" />
|
|
<meta property="og:url" content="https://jenkinsci.github.io/kubernetes-operator/blog/2018/10/06/easy-documentation-with-docsy/" />
|
|
<meta property="og:image" content="https://jenkinsci.github.io/kubernetes-operator/blog/2018/10/06/easy-documentation-with-docsy/featured-sunset-get.png"/>
|
|
<meta property="article:published_time" content="2018-10-06T00:00:00+00:00" />
|
|
<meta property="article:modified_time" content="2018-10-06T00:00:00+00:00" /><meta property="og:site_name" content="Jenkins Operator" />
|
|
<meta itemprop="name" content="Easy documentation with Docsy">
|
|
<meta itemprop="description" content="The Docsy Hugo theme lets project maintainers and contributors focus on content, not on reinventing a website infrastructure from scratch">
|
|
<meta itemprop="datePublished" content="2018-10-06T00:00:00+00:00" />
|
|
<meta itemprop="dateModified" content="2018-10-06T00:00:00+00:00" />
|
|
<meta itemprop="wordCount" content="135">
|
|
<meta itemprop="image" content="https://jenkinsci.github.io/kubernetes-operator/blog/2018/10/06/easy-documentation-with-docsy/featured-sunset-get.png">
|
|
|
|
|
|
|
|
<meta itemprop="keywords" content="" /><meta name="twitter:card" content="summary_large_image"/>
|
|
<meta name="twitter:image" content="https://jenkinsci.github.io/kubernetes-operator/blog/2018/10/06/easy-documentation-with-docsy/featured-sunset-get.png"/>
|
|
<meta name="twitter:title" content="Easy documentation with Docsy"/>
|
|
<meta name="twitter:description" content="The Docsy Hugo theme lets project maintainers and contributors focus on content, not on reinventing a website infrastructure from scratch"/>
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="preload" href="/kubernetes-operator/scss/main.min.fd69987024ae657af26227407273d5b4d1046115af0e0182839a91bb3e30e830.css" as="style">
|
|
<link href="/kubernetes-operator/scss/main.min.fd69987024ae657af26227407273d5b4d1046115af0e0182839a91bb3e30e830.css" rel="stylesheet" integrity="">
|
|
|
|
<script
|
|
src="https://code.jquery.com/jquery-3.3.1.min.js"
|
|
integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8="
|
|
crossorigin="anonymous"></script>
|
|
|
|
|
|
<title>Easy documentation with Docsy | Jenkins Operator</title>
|
|
</head>
|
|
<body class="td-page td-blog">
|
|
<header>
|
|
|
|
<nav class="js-navbar-scroll navbar navbar-expand navbar-dark flex-column flex-md-row td-navbar">
|
|
<a class="navbar-brand" href="/kubernetes-operator/">
|
|
<img style="width: 32px; height: 32px; margin-right: 7.5px;" src="/kubernetes-operator/img/logo.svg"></img><span class="text-uppercase font-weight-bold">Jenkins Operator</span>
|
|
</a>
|
|
<div class="td-navbar-nav-scroll ml-md-auto" id="main_navbar">
|
|
<ul class="navbar-nav mt-2 mt-lg-0">
|
|
<li class="nav-item mr-4 mb-2 mb-lg-0">
|
|
<a class="nav-link" href="/kubernetes-operator/about"><span>What's the Jenkins Operator?</span></a>
|
|
</li>
|
|
<li class="nav-item mr-4 mb-2 mb-lg-0">
|
|
<a class="nav-link" href="/kubernetes-operator/docs"><span>Documentation</span></a>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
<div class="navbar-nav d-none d-lg-block">
|
|
<input type="search" class="form-control td-search-input" placeholder=" Search this site…" aria-label="Search this site…" autocomplete="off">
|
|
</div>
|
|
</nav>
|
|
|
|
</header>
|
|
<div class="container-fluid td-outer">
|
|
<div class="td-main">
|
|
<div class="row flex-xl-nowrap">
|
|
<div class="col-12 col-md-3 col-xl-2 td-sidebar d-print-none">
|
|
|
|
|
|
|
|
|
|
|
|
<div id="td-sidebar-menu" class="td-sidebar__inner">
|
|
|
|
<form class="td-sidebar__search d-flex align-items-center">
|
|
|
|
<input type="search" class="form-control td-search-input" placeholder=" Search this site…" aria-label="Search this site…" autocomplete="off">
|
|
|
|
<button class="btn btn-link td-sidebar__toggle d-md-none p-0 ml-3 fas fa-bars" type="button" data-toggle="collapse" data-target="#td-section-nav" aria-controls="td-docs-nav" aria-expanded="false" aria-label="Toggle section navigation">
|
|
</button>
|
|
</form>
|
|
|
|
<nav class="collapse td-sidebar-nav pt-2 pl-4" id="td-section-nav">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul class="td-sidebar-nav__section pr-md-3">
|
|
<li class="td-sidebar-nav__section-title">
|
|
<a href="/kubernetes-operator/blog/" class="align-left pl-0 pr-2 td-sidebar-link td-sidebar-link__section">Blog</a>
|
|
</li>
|
|
<ul>
|
|
<li class="collapse show" id="kubernetes-operator-blog">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul class="td-sidebar-nav__section pr-md-3">
|
|
<li class="td-sidebar-nav__section-title">
|
|
<a href="/kubernetes-operator/blog/news/" class="align-left pl-0 pr-2 active td-sidebar-link td-sidebar-link__section">News</a>
|
|
</li>
|
|
<ul>
|
|
<li class="collapse show" id="kubernetes-operator-blog-news">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page active" id="m-kubernetes-operator-blog-2018-10-06-easy-documentation-with-docsy" href="/kubernetes-operator/blog/2018/10/06/easy-documentation-with-docsy/">Announcing Docsy</a>
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-blog-2018-10-06-the-second-blog-post" href="/kubernetes-operator/blog/2018/10/06/the-second-blog-post/">Second blog post</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul class="td-sidebar-nav__section pr-md-3">
|
|
<li class="td-sidebar-nav__section-title">
|
|
<a href="/kubernetes-operator/blog/releases/" class="align-left pl-0 pr-2 collapsed td-sidebar-link td-sidebar-link__section">Releases</a>
|
|
</li>
|
|
<ul>
|
|
<li class="collapse " id="kubernetes-operator-blog-releases">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a class="td-sidebar-link td-sidebar-link__page " id="m-kubernetes-operator-blog-2018-01-04-another-great-release" href="/kubernetes-operator/blog/2018/01/04/another-great-release/">Release New Features</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
</ul>
|
|
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
</ul>
|
|
|
|
</nav>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="d-none d-xl-block col-xl-2 td-toc d-print-none">
|
|
|
|
|
|
|
|
|
|
<div class="td-page-meta ml-2 pb-1 pt-2 mb-0">
|
|
|
|
|
|
|
|
<a href="https://github.com/jenkinsci/kubernetes-operator/edit/master/website/content/en/blog/news/first-post/index.md" target="_blank"><i class="fa fa-edit fa-fw"></i> Edit this page</a>
|
|
<a href="https://github.com/jenkinsci/kubernetes-operator/issues/new?title=Easy%20documentation%20with%20Docsy" target="_blank"><i class="fab fa-github fa-fw"></i> Create documentation issue</a>
|
|
|
|
|
|
<a href="https://github.com/jenkinsci/kubernetes-operator/issues/new" target="_blank"><i class="fas fa-tasks fa-fw"></i> Create project issue</a>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<main class="col-12 col-md-9 col-xl-8 pl-md-5 pr-md-4" role="main">
|
|
<a class="btn btn-lg -bg-orange td-rss-button d-none d-lg-block" href="https://jenkinsci.github.io/kubernetes-operator/blog/news/index.xml" target="_blank">
|
|
RSS <i class="fa fa-rss ml-2 "></i>
|
|
</a>
|
|
|
|
<div class="td-content">
|
|
<h1>Easy documentation with Docsy</h1>
|
|
<div class="lead">The Docsy Hugo theme lets project maintainers and contributors focus on content, not on reinventing a website infrastructure from scratch</div>
|
|
<div class="td-byline mb-4">
|
|
By <b>Riona MacNamara (<a href="https://twitter.com/bepsays">@rionam</a>)</b> |
|
|
<time datetime="2018-10-06" class="text-muted">Saturday, October 06, 2018</time>
|
|
</div>
|
|
|
|
|
|
<p><strong>This is a typical blog post that includes images.</strong></p>
|
|
|
|
<p>The front matter specifies the date of the blog post, its title, a short description that will be displayed on the blog landing page, and its author.</p>
|
|
|
|
<h2 id="including-images">Including images</h2>
|
|
|
|
<p>Here’s an image (<code>featured-sunset-get.png</code>) that includes a byline and a caption.</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="card rounded p-2 td-post-card mb-4 mt-4" style="max-width: 610px">
|
|
<img class="card-img-top" src="/kubernetes-operator/blog/2018/10/06/easy-documentation-with-docsy/featured-sunset-get_hu69849a7cdb847c2393a7b3a7f6061c86_387442_600x300_fill_catmullrom_smart1_2.png" width="600" height="300">
|
|
|
|
<div class="card-body px-0 pt-2 pb-0">
|
|
<p class="card-text">
|
|
Fetch and scale an image in the upcoming Hugo 0.43.
|
|
<small class="text-muted"><br/>Photo: Riona MacNamara / CC-BY-CA</small></p>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<p>The front matter of this post specifies properties to be assigned to all image resources:</p>
|
|
<pre><code>resources:
|
|
- src: "**.{png,jpg}"
|
|
title: "Image #:counter"
|
|
params:
|
|
byline: "Photo: Riona MacNamara / CC-BY-CA"</code></pre>
|
|
<p>To include the image in a page, specify its details like this:</p>
|
|
<pre><code>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="card rounded p-2 td-post-card mb-4 mt-4" style="max-width: 610px">
|
|
<img class="card-img-top" src="/kubernetes-operator/blog/2018/10/06/easy-documentation-with-docsy/featured-sunset-get_hu69849a7cdb847c2393a7b3a7f6061c86_387442_600x300_fill_catmullrom_smart1_2.png" width="600" height="300">
|
|
|
|
<div class="card-body px-0 pt-2 pb-0">
|
|
<p class="card-text">
|
|
Fetch and scale an image in the upcoming Hugo 0.43.
|
|
<small class="text-muted"><br/>Photo: Riona MacNamara / CC-BY-CA</small></p>
|
|
</div>
|
|
|
|
</div></code></pre>
|
|
<p>The image will be rendered at the size and byline specified in the front matter.</p>
|
|
|
|
|
|
|
|
<ul class="list-unstyled d-flex justify-content-between align-items-center mb-0 pt-5">
|
|
<li>
|
|
<a href="/kubernetes-operator/blog/2018/10/06/the-second-blog-post/" class="btn btn-primary "><span class="mr-1">←</span> Previous</a>
|
|
</li>
|
|
<a class="btn btn-primary disabled">Next <span class="ml-1">→</span></a>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
|
|
</main>
|
|
</div>
|
|
</div>
|
|
|
|
<footer class="bg-dark py-5 row d-print-none">
|
|
<div class="bg-dark container-fluid trademark-bigger">
|
|
<div class="row">
|
|
<div class="col-6 col-sm-4 text-xs-center order-sm-2">
|
|
|
|
</div>
|
|
<div class="col-6 col-sm-4 text-right text-xs-center order-sm-3">
|
|
|
|
</div>
|
|
<div class="col-12 col-sm-12 text-center py-4 order-sm-2">
|
|
<small class="text-white">© 2020 Jenkins Operator is created by VirtusLab. Source is available under Apache License Version 2 and website content under Creative Commons Attribution-ShareAlike 4.0.</small><br>
|
|
<small class="text-white">Jenkins® is a registered trademark of Software in the Public Interest, Inc.</small>
|
|
|
|
<p class="mt-2"><a href="/kubernetes-operator/about/">What's the Jenkins Operator?</a></p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
|
|
</div>
|
|
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.3/umd/popper.min.js" integrity="sha384-ZMP7rVo3mIykV+2+9J3UJ46jBk0WLaUAdn689aCwoqbBJiSnjAK/l8WvCWPIPm49" crossorigin="anonymous"></script>
|
|
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/js/bootstrap.min.js" integrity="sha384-ChfqqxuZUCnJSK3+MXmPNIyE6ZbWh2IMqE241rYiqJxyMiZ6OW/JmZQ5stwEULTy" crossorigin="anonymous"></script>
|
|
|
|
|
|
|
|
|
|
|
|
<script src="/kubernetes-operator/js/main.min.b0e99aac17991fa76812dd47914049168ac469a1faa0939560f0b370565becab.js" integrity="sha256-sOmarBeZH6doEt1HkUBJForEaaH6oJOVYPCzcFZb7Ks="></script>
|
|
|
|
|
|
|
|
</body>
|
|
</html> |