profectus-docs/assets/guide_creating-your-project_changelog.md.DmQB211g.lean.js

10 lines
7.5 KiB
JavaScript
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import{_ as i,c as a,a0 as t,o as e}from"./chunks/framework.P9qPzDnn.js";const r=JSON.parse('{"title":"Changelog","description":"","frontmatter":{},"headers":[],"relativePath":"guide/creating-your-project/changelog.md","filePath":"guide/creating-your-project/changelog.md","lastUpdated":1737059031000}'),n={name:"guide/creating-your-project/changelog.md"};function h(l,s,k,p,F,D){return e(),a("div",null,s[0]||(s[0]=[t(`<h1 id="changelog" tabindex="-1">Changelog <a class="header-anchor" href="#changelog" aria-label="Permalink to &quot;Changelog&quot;"></a></h1><p>This is a Vue component stored at <code>/src/data/Changelog.vue</code> used to display all the changes version to version. You can use any features you&#39;d like within here, but it&#39;s recommended to simply add new <code>&lt;details&gt;</code> elements for each new major release, and mark the most recent one as <code>open</code> by default. It is strongly advised to not change any of the code relating to making the changelog appear in a modal.</p><p>There is a single version included by default that can serve as a reference of how it is recommended to add a version to the changelog:</p><div class="language-html vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">html</span><pre class="shiki shiki-themes material-theme-palenight material-theme-palenight vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&lt;</span><span style="--shiki-light:#F07178;--shiki-dark:#F07178;">details</span><span style="--shiki-light:#C792EA;--shiki-dark:#C792EA;"> open</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&gt;</span></span>
<span class="line"><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;"> &lt;</span><span style="--shiki-light:#F07178;--shiki-dark:#F07178;">summary</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&gt;</span><span style="--shiki-light:#BABED8;--shiki-dark:#BABED8;">v0.0 Initial Commit - </span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&lt;</span><span style="--shiki-light:#F07178;--shiki-dark:#F07178;">time</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&gt;</span><span style="--shiki-light:#BABED8;--shiki-dark:#BABED8;">2021-09-04</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&lt;/</span><span style="--shiki-light:#F07178;--shiki-dark:#F07178;">time</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&gt;&lt;/</span><span style="--shiki-light:#F07178;--shiki-dark:#F07178;">summary</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&gt;</span></span>
<span class="line"><span style="--shiki-light:#BABED8;--shiki-dark:#BABED8;"> This is the first release :D</span></span>
<span class="line"><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;"> &lt;</span><span style="--shiki-light:#F07178;--shiki-dark:#F07178;">ul</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&gt;</span></span>
<span class="line"><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;"> &lt;</span><span style="--shiki-light:#F07178;--shiki-dark:#F07178;">li</span><span style="--shiki-light:#C792EA;--shiki-dark:#C792EA;"> class</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">=</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&quot;</span><span style="--shiki-light:#C3E88D;--shiki-dark:#C3E88D;">feature</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&quot;</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&gt;</span><span style="--shiki-light:#BABED8;--shiki-dark:#BABED8;">Did everything</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&lt;/</span><span style="--shiki-light:#F07178;--shiki-dark:#F07178;">li</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&gt;</span></span>
<span class="line"><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;"> &lt;</span><span style="--shiki-light:#F07178;--shiki-dark:#F07178;">li</span><span style="--shiki-light:#C792EA;--shiki-dark:#C792EA;"> class</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">=</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&quot;</span><span style="--shiki-light:#C3E88D;--shiki-dark:#C3E88D;">fix</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&quot;</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&gt;</span><span style="--shiki-light:#BABED8;--shiki-dark:#BABED8;">Had some fun</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&lt;/</span><span style="--shiki-light:#F07178;--shiki-dark:#F07178;">li</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&gt;</span></span>
<span class="line"><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;"> &lt;</span><span style="--shiki-light:#F07178;--shiki-dark:#F07178;">li</span><span style="--shiki-light:#C792EA;--shiki-dark:#C792EA;"> class</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">=</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&quot;</span><span style="--shiki-light:#C3E88D;--shiki-dark:#C3E88D;">breaking</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&quot;</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&gt;</span><span style="--shiki-light:#BABED8;--shiki-dark:#BABED8;">Removed everything</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&lt;/</span><span style="--shiki-light:#F07178;--shiki-dark:#F07178;">li</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&gt;</span></span>
<span class="line"><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;"> &lt;</span><span style="--shiki-light:#F07178;--shiki-dark:#F07178;">li</span><span style="--shiki-light:#C792EA;--shiki-dark:#C792EA;"> class</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">=</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&quot;</span><span style="--shiki-light:#C3E88D;--shiki-dark:#C3E88D;">balancing</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&quot;</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&gt;</span><span style="--shiki-light:#BABED8;--shiki-dark:#BABED8;">Created some bugs to fix later</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&lt;/</span><span style="--shiki-light:#F07178;--shiki-dark:#F07178;">li</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&gt;</span></span>
<span class="line"><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;"> &lt;/</span><span style="--shiki-light:#F07178;--shiki-dark:#F07178;">ul</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&gt;</span></span>
<span class="line"><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&lt;/</span><span style="--shiki-light:#F07178;--shiki-dark:#F07178;">details</span><span style="--shiki-light:#89DDFF;--shiki-dark:#89DDFF;">&gt;</span></span></code></pre></div><p>The <code>details</code> and <code>summary</code> tags will create a section that can be collapsed and uncollapsed. While collapsed only the text in the <code>summary</code> tag will appear. By default sections are collapsed, although adding the <code>open</code> attribute to the <code>details</code> element will change that.</p><p>Within the details of the version, you can add a description and a list of changes for that version. CSS classes have been defined to automatically mark a change as a feature, fix, breaking change, or balancing tweak. You can of course add additional tags as you have full control over the entire component.</p>`,6)]))}const g=i(n,[["render",h]]);export{r as __pageData,g as default};