Skip to content

Commit

Permalink
docs: add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yupix committed Jan 21, 2024
1 parent c1a5a85 commit cb47bd2
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# あゆき's BLOG

@aki@sousuke0422 による共同ブログです。
このブログは Hugo を使用しています。 テーマは [hugo-theme-stack](https://github.com/CaiJimmy/hugo-theme-stack) を一部変更した上で使用しています。
実際に使用している[テンプレート](https://github.com/TeamBlackCrystal/hugo-theme-stack)

## 動かし方・ビルド

Hugoのインストール(scoop を使うことを想定しています)

```bash
# Windows
scoop install hugo-extended
```

ローカル用のサーバーを起動する

```bash
hugo server
```

お試しビルドの方法

```bash
hugo
```

実行後に生成された `public` ディレクトリがビルド成果

## 記事の追加方法

> [!NOTE]
> 記事の名前には英数記号のみがサポートされています。日本語はどうなるか分かりません。
```bash
python helper.py new <post name>
```

記事内の `draft = true``false` に変更すると表示されるようになります

0 comments on commit cb47bd2

Please sign in to comment.