Files
sera-new-hp/docs/index.html
2024-10-09 01:40:02 +09:00

23 lines
9.5 KiB
HTML

<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>sera-hp</title><meta name="description" content="Documentation for sera-hp"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">sera-hp</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>sera-hp</h2></div><div class="tsd-panel tsd-typography"><a id="md:sera-new-hp" class="tsd-anchor"></a><h1 class="tsd-anchor-link">sera-new-hp<a href="#md:sera-new-hp" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p>更新が止まっているSERA HPを置き換えるよりモダンなHP</p>
<a id="md:使用言語、ライブラリー、フレームワーク、ツール" class="tsd-anchor"></a><h2 class="tsd-anchor-link">使用言語、ライブラリー、フレームワーク、ツール<a href="#md:使用言語、ライブラリー、フレームワーク、ツール" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
<li>JavaScript、TypeScript、Vue</li>
<li>Nuxt</li>
<li>node npm</li>
<li>sqlite</li>
</ul>
<a id="md:コンテンツの管理" class="tsd-anchor"></a><h2 class="tsd-anchor-link">コンテンツの管理<a href="#md:コンテンツの管理" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>ニュース等のコンテンツの管理は<code>src-manager/</code>内の<code>README.md</code>を参照すること</p>
<a id="md:開発を開始する" class="tsd-anchor"></a><h2 class="tsd-anchor-link">開発を開始する<a href="#md:開発を開始する" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><blockquote>
<p>初めてこのプロジェクトに参加する際には<code>CONTRIBUTING.md</code><em><strong>必ず</strong></em>読んでおくこと</p>
</blockquote>
<pre><code class="bash"><span class="hl-0">git</span><span class="hl-1"> </span><span class="hl-2">clone</span><span class="hl-1"> </span><span class="hl-2">https://git.kenryu.us/kenryuS/sera-new-hp.git</span><span class="hl-1"> </span><span class="hl-3"># レポジトリをクローン</span><br/><span class="hl-0">cd</span><span class="hl-1"> </span><span class="hl-2">sera-new-hp</span><span class="hl-1"> </span><span class="hl-3"># 移動して</span><br/><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-3"># 依存パッケージのインストール</span><br/><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">dev</span><span class="hl-1"> </span><span class="hl-3"># デベロッパーモードでサーバーを起動</span><br/><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">generate</span><span class="hl-1"> </span><span class="hl-3"># 静的サイトを生成</span>
</code><button type="button">Copy</button></pre>
<a id="md:便利・重要なファイルフォルダ" class="tsd-anchor"></a><h2 class="tsd-anchor-link">便利・重要なファイル/フォルダ<a href="#md:便利・重要なファイルフォルダ" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
<li><code>assets/databases/news.db</code>: ニュースを管理しているsqliteデータベース</li>
<li><code>assets/siteinfo.json</code>: 部長と顧問の名前、コピーライトの年、メンバーの学科・学年ごとの人数、など更新があまりされない情報を集めたファイル、<code>import</code>して使う</li>
<li><code>assets/achievements.json</code>: 活動実績に表示される参加・受賞歴を集めたファイル</li>
<li><code>docs/</code>: <code>typedoc</code>で生成されたドキュメンテーションが入っている、<code>python -m http.server</code>などで<code>localhost</code>にホストして読む</li>
<li><code>dist/</code>, <code>.output/</code>: <code>npm run generate</code>で生成された静的ウェブサイト本体、プロダクションレディーな状態 <code>dist/</code><code>.output/</code>へのリンクである</li>
</ul>
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:sera-new-hp"><span>sera-<wbr/>new-<wbr/>hp</span></a><ul><li><a href="#md:使用言語、ライブラリー、フレームワーク、ツール"><span>使用言語、ライブラリー、フレームワーク、ツール</span></a></li><li><a href="#md:コンテンツの管理"><span>コンテンツの管理</span></a></li><li><a href="#md:開発を開始する"><span>開発を開始する</span></a></li><li><a href="#md:便利・重要なファイルフォルダ"><span>便利・重要なファイル/フォルダ</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="index.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>sera-hp</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>