-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
13 changed files
with
70 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,2 @@ | ||
/.venv | ||
/.venv | ||
.DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` | ||
|
||
詳しくはハンドブック内の「ハンドブックの開発 (開発者向け)」を参照してください。 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# 用語集 (ハンドブック) |
Empty file.
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# 用語集 (営業) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# 用語集 (人事・労務) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# 用語集 (営業) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# 用語集 (経理) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# 用語集 (総務) |
Empty file.
Empty file.
Empty file.