Skip to content

Commit

Permalink
some fix
Browse files Browse the repository at this point in the history
  • Loading branch information
miya0001 committed Nov 11, 2024
1 parent d22ccf8 commit 1a2cb58
Show file tree
Hide file tree
Showing 13 changed files with 70 additions and 2 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
/.venv
/.venv
.DS_Store
63 changes: 62 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,62 @@
# Geolonia ハンドブック
# Geolonia ハンドブック


## ハンドブックの開発

### macOS

まず Python をインストールしてください。

```
$ brew install python
```

リポジトリを `git clone` して、作業用ディレクトリ内に移動してください。

```
$ git clone https://github.com/geolonia/handbook.geolonia.com
$ cd handbook.geolonia.com
```

作業用ディレクトリ内にPythonの仮想環境を作ってください。

```
$ python3 -m venv .venv && source .venv/bin/activate
```

以上で仮想環境ができました。以下のコマンドを実行すると `python` コマンドのパスが `.venv` 内のパスに変わっていることを確認できます。

```
$ which python
$ which pip
```

必要なパッケージをインストールしてください。

```
$ pip install --upgrade pip
$ pip install -r requirments.txt
```

`mkdocs serve` コマンドを実行すると、`http://127.0.0.1:8000/` でローカル環境上のハンドブックにアクセスすることができます。

```
$ mkdocs serve
INFO - Building documentation...
INFO - Cleaning site directory
INFO - Documentation built in 0.15 seconds
INFO - [14:52:00] Watching paths for changes: 'docs', 'mkdocs.yml'
INFO - [14:52:00] Serving on http://127.0.0.1:8000/
INFO - [14:52:01] Browser connected: http://127.0.0.1:8000/
```

後日作業を再開するには以下のような手順で再開することができます。

```
$ git pull
$ source .venv/bin/activate
$ pip install --upgrade pip && pip install -r requirments.txt
$ mkdocs serve
```

詳しくはハンドブック内の「ハンドブックの開発 (開発者向け)」を参照してください。
1 change: 1 addition & 0 deletions docs/ハンドブックについて/glossary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# 用語集 (ハンドブック)
Empty file removed docs/人事・労務/.gitkeep
Empty file.
Empty file removed docs/営業/.gitkeep
Empty file.
1 change: 1 addition & 0 deletions docs/組織別/マーケティング/glossary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# 用語集 (営業)
1 change: 1 addition & 0 deletions docs/組織別/人事・労務/glossary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# 用語集 (人事・労務)
1 change: 1 addition & 0 deletions docs/組織別/営業/glossary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# 用語集 (営業)
1 change: 1 addition & 0 deletions docs/組織別/経理/glossary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# 用語集 (経理)
1 change: 1 addition & 0 deletions docs/組織別/総務/glossary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# 用語集 (総務)
Empty file removed docs/経理/.gitkeep
Empty file.
Empty file removed docs/総務/.gitkeep
Empty file.
Empty file removed docs/開発/.gitkeep
Empty file.

0 comments on commit 1a2cb58

Please sign in to comment.