Updated Docs

This commit is contained in:
2024-10-09 01:40:02 +09:00
parent 9b35e48e68
commit 780905fb4e
14 changed files with 51 additions and 12 deletions

View File

@@ -15,6 +15,7 @@
<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>