Hikage/assets/quick-start.html-pPBKXKHH.js

import{_ as r,r as i,o as p,c as d,b as e,d as n,a as s,w as o,e as t}from"./app-Th5ZUiPV.js";const c={},u=t('<h1 id="quick-start" tabindex="-1"><a class="header-anchor" href="#quick-start" aria-hidden="true">#</a> Quick Start</h1><blockquote><p>Integrate <code>Hikage</code> into your project.</p></blockquote><h2 id="project-requirements" tabindex="-1"><a class="header-anchor" href="#project-requirements" aria-hidden="true">#</a> Project Requirements</h2><p>The project needs to be created using <code>Android Studio</code> or <code>IntelliJ IDEA</code> and must be an Android or Kotlin Multiplatform project with integrated Kotlin environment dependencies.</p>',4),h={href:"https://developer.android.com/studio",target:"_blank",rel:"noopener noreferrer"},m={href:"https://www.jetbrains.com/idea",target:"_blank",rel:"noopener noreferrer"},y=e("li",null,[e("p",null,"Kotlin 1.9.0+, Gradle 8+, Java 17+, Android Gradle Plugin 8+")],-1),v=e("h3",{id:"configure-repositories",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#configure-repositories","aria-hidden":"true"},"#"),n(" Configure Repositories")],-1),b=e("p",null,[n("The dependencies of "),e("code",null,"Hikage"),n(" are published in "),e("strong",null,"Maven Central"),n(" and our public repository, you can use the following method to configure repositories.")],-1),g={href:"https://github.com/HighCapable/SweetDependency",target:"_blank",rel:"noopener noreferrer"},A=t(`<h4 id="sweetdependency-recommended" tabindex="-1"><a class="header-anchor" href="#sweetdependency-recommended" aria-hidden="true">#</a> SweetDependency (Recommended)</h4><p>Configure repositories in your project&#39;s <code>SweetDependency</code> configuration file.</p><div class="language-yaml line-numbers-mode" data-ext="yml"><pre class="shiki github-dark-dimmed" style="background-color:#22272e;" tabindex="0"><code><span class="line"><span style="color:#8DDB8C;">repositories</span><span style="color:#ADBAC7;">:</span></span>
<span class="line"><span style="color:#ADBAC7;">  </span><span style="color:#8DDB8C;">google</span><span style="color:#ADBAC7;">:</span></span>
<span class="line"><span style="color:#ADBAC7;">  </span><span style="color:#8DDB8C;">maven-central</span><span style="color:#ADBAC7;">:</span></span>
<span class="line"><span style="color:#ADBAC7;">  </span><span style="color:#768390;"># (Optional) You can add this URL to use our public repository</span></span>
<span class="line"><span style="color:#ADBAC7;">  </span><span style="color:#768390;"># When Sonatype-OSS fails and cannot publish dependencies, this repository is added as a backup</span></span>
<span class="line"><span style="color:#ADBAC7;">  </span><span style="color:#768390;"># For details, please visit: https://github.com/HighCapable/maven-repository</span></span>
<span class="line"><span style="color:#ADBAC7;">  </span><span style="color:#8DDB8C;">highcapable-maven-releases</span><span style="color:#ADBAC7;">:</span></span>
<span class="line"><span style="color:#ADBAC7;">    </span><span style="color:#8DDB8C;">url</span><span style="color:#ADBAC7;">: </span><span style="color:#96D0FF;">https://raw.githubusercontent.com/HighCapable/maven-repository/main/repository/releases</span></span>
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h4 id="traditional-method" tabindex="-1"><a class="header-anchor" href="#traditional-method" aria-hidden="true">#</a> Traditional Method</h4><p>Configure dependency in your project&#39;s <code>build.gradle.kts</code>.</p><div class="language-kotlin line-numbers-mode" data-ext="kt"><pre class="shiki github-dark-dimmed" style="background-color:#22272e;" tabindex="0"><code><span class="line"><span style="color:#DCBDFB;">repositories</span><span style="color:#ADBAC7;"> {</span></span>
<span class="line"><span style="color:#ADBAC7;">    </span><span style="color:#DCBDFB;">google</span><span style="color:#ADBAC7;">()</span></span>
<span class="line"><span style="color:#ADBAC7;">    </span><span style="color:#DCBDFB;">mavenCentral</span><span style="color:#ADBAC7;">()</span></span>
<span class="line"><span style="color:#ADBAC7;">    </span><span style="color:#768390;">// (Optional) You can add this URL to use our public repository</span></span>
<span class="line"><span style="color:#ADBAC7;">    </span><span style="color:#768390;">// When Sonatype-OSS fails and cannot publish dependencies, this repository is added as a backup</span></span>
<span class="line"><span style="color:#ADBAC7;">    </span><span style="color:#768390;">// For details, please visit: https://github.com/HighCapable/maven-repository</span></span>
<span class="line"><span style="color:#ADBAC7;">    </span><span style="color:#DCBDFB;">maven</span><span style="color:#ADBAC7;">(</span><span style="color:#96D0FF;">&quot;https://raw.githubusercontent.com/HighCapable/maven-repository/main/repository/releases&quot;</span><span style="color:#ADBAC7;">)</span></span>
<span class="line"><span style="color:#ADBAC7;">}</span></span>
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="configure-java-version" tabindex="-1"><a class="header-anchor" href="#configure-java-version" aria-hidden="true">#</a> Configure Java Version</h3><p>Modify the Java version of Kotlin in your project&#39;s <code>build.gradle.kts</code> to 17 or above.</p><blockquote><p>Kotlin DSL</p></blockquote><div class="language-kotlin line-numbers-mode" data-ext="kt"><pre class="shiki github-dark-dimmed" style="background-color:#22272e;" tabindex="0"><code><span class="line"><span style="color:#DCBDFB;">android</span><span style="color:#ADBAC7;"> {</span></span>
<span class="line"><span style="color:#ADBAC7;">    </span><span style="color:#DCBDFB;">compileOptions</span><span style="color:#ADBAC7;"> {</span></span>
<span class="line"><span style="color:#ADBAC7;">        sourceCompatibility </span><span style="color:#F47067;">=</span><span style="color:#ADBAC7;"> JavaVersion.VERSION_17</span></span>
<span class="line"><span style="color:#ADBAC7;">        targetCompatibility </span><span style="color:#F47067;">=</span><span style="color:#ADBAC7;"> JavaVersion.VERSION_17</span></span>
<span class="line"><span style="color:#ADBAC7;">    }</span></span>
<span class="line"><span style="color:#ADBAC7;">    </span><span style="color:#DCBDFB;">kotlinOptions</span><span style="color:#ADBAC7;"> {</span></span>
<span class="line"><span style="color:#ADBAC7;">        jvmTarget </span><span style="color:#F47067;">=</span><span style="color:#ADBAC7;"> </span><span style="color:#96D0FF;">&quot;17&quot;</span></span>
<span class="line"><span style="color:#ADBAC7;">    }</span></span>
<span class="line"><span style="color:#ADBAC7;">}</span></span>
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="functional-overview" tabindex="-1"><a class="header-anchor" href="#functional-overview" aria-hidden="true">#</a> Functional Overview</h2><p>The project is divided into multiple modules. You can choose the module you wish to include as a dependency in your project, but be sure to include the <strong>hikage-core</strong> module.</p><p>Click the corresponding module below to view detailed feature descriptions.</p>`,13),D=e("h2",{id:"demo",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#demo","aria-hidden":"true"},"#"),n(" Demo")],-1),C={href:"https://github.com/BetterAndroid/Hikage/tree/main/samples",target:"_blank",rel:"noopener noreferrer"};function B(k,f){const l=i("ExternalLinkIcon"),a=i("RouterLink");return p(),d("div",null,[u,e("ul",null,[e("li",null,[e("p",null,[n("Android Studio (It is recommended to get the latest version from "),e("a",h,[n("here"),s(l)]),n(")")])]),e("li",null,[e("p",null,[n("IntelliJ IDEA (It is recommended to get the latest version from "),e("a",m,[n("here"),s(l)]),n(")")])]),y]),v,b,e("p",null,[n("We recommend using Kotlin DSL as the Gradle build script language and "),e("a",g,[n("SweetDependency"),s(l)]),n(" to manage dependencies.")]),A,e("ul",null,[e("li",null,[s(a,{to:"/en/library/hikage-core.html"},{default:o(()=>[n("hikage-core")]),_:1})]),e("li",null,[s(a,{to:"/en/library/hikage-compiler.html"},{default:o(()=>[n("hikage-compiler")]),_:1})]),e("li",null,[s(a,{to:"/en/library/hikage-extension.html"},{default:o(()=>[n("hikage-extension")]),_:1})]),e("li",null,[s(a,{to:"/en/library/hikage-extension-betterandroid.html"},{default:o(()=>[n("hikage-extension-betterandroid")]),_:1})]),e("li",null,[s(a,{to:"/en/library/hikage-extension-compose.html"},{default:o(()=>[n("hikage-extension-compose")]),_:1})]),e("li",null,[s(a,{to:"/en/library/hikage-widget-androidx.html"},{default:o(()=>[n("hikage-widget-androidx")]),_:1})]),e("li",null,[s(a,{to:"/en/library/hikage-widget-material.html"},{default:o(()=>[n("hikage-widget-material")]),_:1})])]),D,e("p",null,[n("You can find some samples "),e("a",C,[n("here"),s(l)]),n(" to view the corresponding demo project to better understand how these functions work and quickly select the functions you need.")])])}const x=r(c,[["render",B],["__file","quick-start.html.vue"]]);export{x as default};