Skip to content

Commit e0bb6bd

Browse files
authored
Merge pull request #61 from jinseok1006/main
Jhelper 문서 최신화
2 parents be30b23 + 1f32e4f commit e0bb6bd

36 files changed

+680
-419
lines changed

README.md

Lines changed: 6 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,20 @@
1-
# JEdutools Documentation
1+
# JHelper: JEdutools Documentation
22

3-
전북대학교 SW교육도구모음 JEduTools의 통합 문서입니다.
3+
전북대학교 SW교육도구모음 JEduTools의 통합 문서 JHelper입니다.
44

5-
## 프로젝트 빌드 및 확인 방법
5+
## 기여 가이드
66

7-
### 로컬 개발 환경 설정
7+
[JHelper](https://jhelper.jbnu.ac.kr)의 JHelper 섹션을 따라 진행하시기 바랍니다.
88

9-
1. 저장소 클론
10-
```bash
11-
git clone https://github.com/JBNU-JEduTools/JHelper.git
12-
cd JHelper
13-
```
14-
15-
2. 의존성 설치
16-
```bash
17-
yarn install
18-
```
19-
첫 설치 시, 시스템 사양에 따라 3-5분 정도 걸릴 수 있습니다.
20-
21-
### 캐시 정리
22-
문서 변경사항이 제대로 반영되지 않거나 빌드 오류가 발생할 경우, 다음 명령어로 캐시를 정리할 수 있습니다:
23-
```bash
24-
yarn clean
25-
```
26-
27-
3. 개발 서버 실행
28-
```bash
29-
yarn run develop
30-
```
31-
개발 서버가 실행되면 `http://localhost:8000`에서 문서를 확인할 수 있습니다.
32-
33-
다른 포트로 개발 서버를 실행하려면 다음 명령어를 사용합니다:
34-
```bash
35-
yarn run develop -p 3000 # 3000번 포트로 실행
36-
```
37-
위 명령어를 실행하면 `http://localhost:3000`에서 문서를 확인할 수 있습니다.
38-
39-
### 빌드 및 배포
40-
41-
프로젝트 빌드:
42-
```bash
43-
yarn run build
44-
```
45-
46-
GitHub Pages 배포를 위한 빌드:
47-
```bash
48-
yarn run build:ghpage
49-
```
50-
이 명령어는 `docs` 디렉토리에 빌드 결과물을 생성합니다.
51-
52-
### GitHub Codespace 개발 환경 구성
53-
54-
로컬 환경에서 개발 환경 구성이 어려운 경우, GitHub Codespace를 활용할 수 있습니다:
55-
56-
1. JHelper 저장소를 포크하여 개인 저장소로 복제합니다.
57-
2. 포크한 저장소에서 Codespace를 생성합니다.
58-
3. 웹 기반 Visual Studio Code 환경에서 작업을 수행합니다.
59-
4. 개발 서버 미리보기는 포트 패널에서 8000번 포트 주소를 통해 접근할 수 있습니다.
60-
5. 작업 완료 후에는 할당된 Codespace 사용량을 고려하여 Codespace를 삭제합니다.
619

62-
### 원본 프로젝트
10+
## 원본 프로젝트
6311

6412
JEduTools 도움말 프로젝트는 codebushi의 gatsby-theme-document-example를 수정해 사용하고 있습니다.
6513
```
6614
git clone https://github.com/codebushi/gatsby-theme-document-example
6715
```
6816

69-
# 릴리즈
17+
## 릴리즈
7018

7119
V1.0.0 (Released 23.06.04)
7220
1. 기본 문서 템플릿 적용

content/JCloud/JCloudPortGuide.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ slug: 'JCloud/2PortGuide'
99

1010

1111
### 1. IP 확인
12-
- 공인IP: 113.198.66.xxx
12+
- 공인IP: 160.160.66.xxx
1313
- JCloud의 왼쪽 상단 프로젝트 메뉴에서, 각 프로젝트 별로 확인 가능
1414
- (예제) capstone 프로젝트의 경우, 113.198.66.74 사용 (아래 그림 참조)
1515

content/JHelper.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@ JHelper는 JEdutools의 도움말 페이지를 제작하고, 배포하기 위한
1616

1717
## Contribution
1818

19-
Contribution은 [개발자 매뉴얼](https://jhelper.jbnu.ac.kr/JHelper/2devManual)을 참고바랍니다.
19+
JHelper 프로젝트에 기여하는 방법은 다음 가이드를 참고해 주세요:
20+
- [1. 시작하기](/JHelper/1gettingStarted)
21+
- [2. 콘텐츠 관리](/JHelper/2contentManagement)
22+
- [3. 기여 가이드](/JHelper/3contribution)
2023

2124

2225
## 버그 제보 및 기능 제안
69.9 KB
Loading
81.2 KB
Loading
137 KB
Loading
185 KB
Loading
83.6 KB
Loading
151 KB
Loading
97.8 KB
Loading

0 commit comments

Comments
 (0)