added PageTop component, markdown styles, white background on logo svg, and documentation comments

This commit is contained in:
2024-09-26 23:59:47 +09:00
parent a55bd18ebc
commit e1cac6ff05
34 changed files with 3345 additions and 2113 deletions

View File

@@ -9,6 +9,10 @@
* node npm
* sqlite
## コンテンツの管理
ニュース等のコンテンツの管理は`src-manager/`内の`README.md`を参照すること
## 開発を開始する
> 初めてこのプロジェクトに参加する際には`CONTRIBUTING.md`を***必ず***読んでおくこと
@@ -17,5 +21,13 @@
git clone https://git.kenryu.us/kenryuS/sera-new-hp.git # レポジトリをクローン
cd sera-new-hp # 移動して
npm install # 依存パッケージのインストール
npm run dev # デベロッパーモードでサイトを構築
npm run dev # デベロッパーモードでサーバーを起動
npm run generate # 静的サイトを生成
```
## 便利・重要なファイル/フォルダ
* `assets/databases/news.db`: ニュースを管理しているsqliteデータベース
* `assets/siteinfo.json`: 部長と顧問の名前、コピーライトの年、メンバーの学科・学年ごとの人数、など更新があまりされない情報を集めたファイル、`import`して使う
* `docs/`: `typedoc`で生成されたドキュメンテーションが入っている、`python -m http.server`などで`localhost`にホストして読む
* `dist/`, `.output/`: `npm run generate`で生成された静的ウェブサイト本体、プロダクションレディーな状態 `dist/``.output/`へのリンクである