Skip to content

Commit 3da4efd

Browse files
unoheeunohee
authored
Merge pull request #34 from unohee/docs/seo-mkdocs-improvements
docs(seo): add OG/Twitter card meta, robots.txt, custom overrides
2 parents 24f8ce4 + 7883c9f commit 3da4efd

5 files changed

Lines changed: 104 additions & 6 deletions

File tree

‎docs/assets/og-image.png‎

63.3 KB
Loading

‎docs/index.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1-
# KIS-Agent
1+
---
2+
title: KIS-Agent — 한국투자증권 OpenAPI Python SDK & CLI
3+
description: 한국투자증권 OpenAPI를 위한 Python 래퍼 라이브러리. CLI·Python SDK·LLM Agent·MCP 서버를 통해 국내/해외 주식, 선물옵션, 실시간 WebSocket 시세와 자동매매를 지원합니다.
4+
keywords: 한국투자증권, KIS OpenAPI, Python, SDK, CLI, kis-agent, 주식 API, 자동매매, 트레이딩, WebSocket, LLM Agent, MCP, pykis, 국내주식, 해외주식, 선물옵션
5+
---
6+
7+
# KIS-Agent — 한국투자증권 OpenAPI Python 래퍼
28

3-
**한국투자증권 OpenAPI Python 래퍼** — CLI & Python SDK
9+
**CLI와 Python SDK로 쉽게 쓰는 한국투자증권 OpenAPI** — 국내·해외 주식, 선물옵션, 실시간 WebSocket, LLM Agent 연동까지.
410

511
[![PyPI version](https://badge.fury.io/py/kis-agent.svg)](https://pypi.org/project/kis-agent/)
612
[![PyPI Downloads](https://img.shields.io/pypi/dm/kis-agent.svg)](https://pypi.org/project/kis-agent/)

‎docs/robots.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
User-agent: *
2+
Allow: /
3+
4+
Sitemap: https://unohee.github.io/kis-agent/sitemap.xml

‎mkdocs.yml‎

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
1-
site_name: KIS-Agent
2-
site_description: 한국투자증권 OpenAPI Python 래퍼 — CLI & Python SDK
3-
site_url: https://unohee.github.io/kis-agent
1+
site_name: KIS-Agent — 한국투자증권 OpenAPI Python SDK
2+
site_description: 한국투자증권 OpenAPI Python 래퍼. CLI와 Python SDK로 국내·해외 주식, 선물옵션, 실시간 WebSocket, 자동매매, LLM Agent·MCP 연동을 지원합니다. pip install kis-agent 한 줄로 시작하세요.
3+
site_author: unohee
4+
site_url: https://unohee.github.io/kis-agent/
45
repo_url: https://github.com/unohee/kis-agent
56
repo_name: unohee/kis-agent
7+
edit_uri: edit/main/docs/
8+
copyright: Copyright © 2025 unohee — MIT License
69

710
theme:
811
name: material
912
language: ko
13+
custom_dir: overrides
1014
palette:
1115
- media: "(prefers-color-scheme: light)"
1216
scheme: default
@@ -36,7 +40,10 @@ theme:
3640

3741
plugins:
3842
- search:
39-
lang: ko
43+
lang:
44+
- ko
45+
- en
46+
- tags
4047

4148
markdown_extensions:
4249
- admonition
@@ -77,8 +84,24 @@ nav:
7784
- Changelog: changelog.md
7885

7986
extra:
87+
generator: false
88+
# Search Console 등록 시 인증 코드를 여기에 채워 넣으세요.
89+
# google_site_verification: "YOUR_GOOGLE_CODE"
90+
# naver_site_verification: "YOUR_NAVER_CODE"
8091
social:
8192
- icon: fontawesome/brands/github
8293
link: https://github.com/unohee/kis-agent
94+
name: GitHub 저장소
8395
- icon: fontawesome/brands/python
8496
link: https://pypi.org/project/kis-agent/
97+
name: PyPI 패키지
98+
analytics:
99+
feedback:
100+
title: 이 페이지가 도움이 되었나요?
101+
ratings:
102+
- icon: material/thumb-up-outline
103+
name: 도움이 되었습니다
104+
data: 1
105+
- icon: material/thumb-down-outline
106+
name: 개선이 필요합니다
107+
data: 0

‎overrides/main.html‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
{% extends "base.html" %}
2+
3+
{#-
4+
SEO 최적화 블록: OG / Twitter Card / canonical / JSON-LD / 추가 메타.
5+
page.meta 우선, 없으면 config 기본값 사용.
6+
-#}
7+
8+
{% block extrahead %}
9+
{% set page_title = (page.meta and page.meta.title) or page.title or config.site_name %}
10+
{% set page_desc = (page.meta and page.meta.description) or config.site_description %}
11+
{% set page_url = page.canonical_url or config.site_url %}
12+
{% set og_image = (page.meta and page.meta.image) or (config.site_url ~ 'assets/og-image.png') %}
13+
{% set site_keywords = 'KIS, 한국투자증권, OpenAPI, Python, SDK, CLI, 주식 API, 트레이딩, 자동매매, WebSocket, LLM Agent, MCP, kis-agent, pykis, 국내주식, 해외주식, 선물옵션' %}
14+
{% set page_keywords = (page.meta and page.meta.keywords) or site_keywords %}
15+
16+
{% if config.extra.google_site_verification %}<meta name="google-site-verification" content="{{ config.extra.google_site_verification }}">{% endif %}
17+
{% if config.extra.naver_site_verification %}<meta name="naver-site-verification" content="{{ config.extra.naver_site_verification }}">{% endif %}
18+
19+
<link rel="canonical" href="{{ page_url }}">
20+
<meta name="description" content="{{ page_desc }}">
21+
<meta name="keywords" content="{{ page_keywords }}">
22+
<meta name="author" content="unohee">
23+
<meta name="robots" content="index, follow, max-image-preview:large, max-snippet:-1, max-video-preview:-1">
24+
<meta name="googlebot" content="index, follow">
25+
26+
<meta property="og:type" content="website">
27+
<meta property="og:site_name" content="{{ config.site_name }}">
28+
<meta property="og:title" content="{{ page_title }}">
29+
<meta property="og:description" content="{{ page_desc }}">
30+
<meta property="og:url" content="{{ page_url }}">
31+
{% if og_image %}<meta property="og:image" content="{{ og_image }}">{% endif %}
32+
<meta property="og:locale" content="ko_KR">
33+
34+
<meta name="twitter:card" content="{% if og_image %}summary_large_image{% else %}summary{% endif %}">
35+
<meta name="twitter:title" content="{{ page_title }}">
36+
<meta name="twitter:description" content="{{ page_desc }}">
37+
{% if og_image %}<meta name="twitter:image" content="{{ og_image }}">{% endif %}
38+
39+
<script type="application/ld+json">
40+
{
41+
"@context": "https://schema.org",
42+
"@type": "SoftwareApplication",
43+
"name": "KIS-Agent",
44+
"alternateName": "kis-agent",
45+
"description": "{{ config.site_description }}",
46+
"url": "{{ config.site_url }}",
47+
"applicationCategory": "DeveloperApplication",
48+
"operatingSystem": "Cross-platform",
49+
"programmingLanguage": "Python",
50+
"offers": {
51+
"@type": "Offer",
52+
"price": "0",
53+
"priceCurrency": "USD"
54+
},
55+
"author": {
56+
"@type": "Person",
57+
"name": "unohee",
58+
"url": "https://github.com/unohee"
59+
},
60+
"codeRepository": "https://github.com/unohee/kis-agent",
61+
"license": "https://opensource.org/licenses/MIT",
62+
"keywords": "{{ site_keywords }}"
63+
}
64+
</script>
65+
{% endblock %}

0 commit comments

Comments
 (0)