42 Tokyo 起業部

サイト作成マニュアル

サイトにプロジェクトの内容を掲載する方法

手順

  1. プロジェクトのレポジトリを作成する。このとき必ずレポジトリ名の中に「project」を含むこと
  2. そのレポジトリないに「public」というディレクトリを作成する。
  3. publicディレクトリの中に必要に応じてマークダウン形式のファイルをアップロードする。

下記がディレクトリ構成の一例である。

repo-project/
├── public/
│   ├── about.md
│   ├── date.md
│   ├── _index.md
│   └── dir/
│       ├── about.md
│       └── _index.md
└── README.md

それぞれのマークダウン形式のファイルには下記のような形式の先頭部(Front Matter)を必ず付けること。 （つけない場合公開されない）

---
title: "プロジェクト名やページのタイトル"
date: 2024-11-18
---

Front Matterには下記のようなパラメーターを設定することも可能である。

---
title: "プロジェクト名やページのタイトル"
date: 2024-11-18
description: "ページの簡単な説明や概要"
draft: true
categories:
  - カテゴリ名1
  - カテゴリ名2
tags:
  - タグ1
  - タグ2
---

それぞれのパラメーターの解説は下記である。

  1. title
    • ページのタイトルを定義
    • HTMLの<title>タグやヘッダーに表示される
  2. date
    • ページの公開日や作成日を指定
  3. description
    • ページの説明を追加
    • SEOやSNSシェア時の説明文として利用
  4. draft
    • trueの場合、サイトに公開されない
  5. categories
    • ページを分類するためのカテゴリ
  6. tags
    • カテゴリと同様にページを分類するためのタグ

記載サンプル

---
title: "42 Tokyo 起業部: マークダウンの機能一覧"
date: 2024-11-19
description: "マークダウンの機能の一覧について解説"
draft: false
categories:
  - マークダウン
  - プロジェクト管理
tags:
  - マークダウン
  - 起業
  - プロジェクト
  - イノベーション
---

# マークダウン機能一覧

## 見出し
# 見出し1
## 見出し2
### 見出し3
#### 見出し4
##### 見出し5
###### 見出し6

## 強調
**太字**
*斜体*
~~取り消し線~~

## リスト

### 番号なしリスト
- アイテム1
  - サブアイテム1
  - サブアイテム2
- アイテム2

### 番号付きリスト
1. アイテム1
2. アイテム2
   1. サブアイテム1
   2. サブアイテム2

## 引用
> これは引用です。
>> 入れ子の引用も可能です。

## コードブロック

### インラインコード
`インラインコード`

## リンク
[リンクテキスト](https://example.com)

## 画像
![代替テキスト](https://example.com/image.png)

## テーブル
| 見出し1 | 見出し2 |
|---------|---------|
| 内容1   | 内容2   |
| 内容3   | 内容4   |

## 水平線
---

## チェックリスト
- [ ] タスク1
- [x] 完了したタスク

## 特殊文字のエスケープ
\* これはエスケープされたアスタリスク \*

## HTML
<p>HTMLも利用可能</p>

公開

上記の手順を踏んで作成されたマークダウンファイルは、毎日午前４時２分に、起業部のホームページに反映される。