star7th/showdoc

어떤 프로젝트인가요?

핵심 기능

• 01페이지를 빠르게 만들 수 있는 API 인터페이스 및 데이터 사전 템플릿을 기본 제공합니다.
• 02페이지별 버전 기록을 지원하는 Markdown 편집기입니다.
• 03멤버 관리와 소유권 이전을 지원하는 공개 및 비공개 프로젝트입니다.
• 04데스크톱과 모바일에서 읽기 편한 반응형 레이아웃입니다.
• 05프로젝트를 오프라인용 Word 문서로 내보낼 수 있습니다.
• 06자체 서버에 호스팅할 수 있습니다.

활용 사례

• 프론트엔드 및 모바일 개발자가 활용할 수 있도록 백엔드 API를 문서화합니다.
• 각 필드를 설명하는 데이터베이스 데이터 사전을 관리합니다.
• 팀에서 사용할 내부 도구 안내서나 기술 사양서를 작성합니다.
• 문서가 없는 레거시 프로젝트를 인수합니다.

빠른 시작

1. 1

   AutoInstall 가이드를 따라 자체 서버에 배포하세요

사용 전 알아둘 점

• !셀프 호스팅이 필요하며, Nginx 또는 Apache를 사용하는 경우 보안을 위해 Sqlite/ 디렉터리에 대한 접근을 차단해야 합니다.
• !메타데이터에는 라이선스가 NOASSERTION으로 표시되어 있으며, README에는 Apache 2.0 외에 저작권 표시와 링크를 UI에 유지해야 한다는 추가 저작권 조건이 명시되어 있습니다.

포함된 컬렉션

토픽

자주 묻는 질문

showdoc은(는) 무엇인가요?

API 문서, 데이터 사전, Markdown 기반 팀 위키에 중점을 둔 IT 팀용 셀프 호스팅 문서 도구입니다. ShowDoc은 소프트웨어 팀을 위한 웹 기반 문서 공유 도구입니다. 한 사람이 작성한 코드를 최신 문서 없이 다른 사람이 이어받기 어렵고, Word 파일이나 채팅 메시지에 흩어진 문서는 금세 오래된 정보가 되는 문제를 해결합니다.

showdoc은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?

showdoc은(는) Other 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.

showdoc은(는) 아직 유지보수되고 있나요?

활발히 유지보수 중. showdoc의 마지막 커밋은 2026년 11월 7일입니다.

showdoc은(는) 어디에 사용할 수 있나요?

프론트엔드 및 모바일 개발자가 활용할 수 있도록 백엔드 API를 문서화합니다. 각 필드를 설명하는 데이터베이스 데이터 사전을 관리합니다. 팀에서 사용할 내부 도구 안내서나 기술 사양서를 작성합니다. 문서가 없는 레거시 프로젝트를 인수합니다.

showdoc는 어떻게 설치하나요?

AutoInstall 가이드를 따라 자체 서버에 배포하세요

showdoc은(는) 어디서 받을 수 있나요?

소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/star7th/showdoc