홈으로 돌아가기

Opensophy Hub: Markdown 문서화를 위한 SSG/SPA

Opensophy Hub — 확장 Markdown 기반 기술 문서 웹사이트를 생성하는 오픈소스 플랫폼입니다. 파일 구조로부터 자동 네비게이션, 상호작용 테이블, UI playgrounds가 콘텐츠 게시를 간소화합니다. 라이브 미리보기 내장 CMS 편집기가 개발자 워크플로를 가속화합니다.

Opensophy Hub: IT 문서화를 위한 강력한 Markdown
Advertisement 728x90

Opensophy Hub: 고급 Markdown 문서화를 위한 정적 SSG/SPA 플랫폼

Opensophy Hub는 기술 문서, 아티클, 매뉴얼을 게시하기 위해 설계된 하이브리드 SSG 및 SPA 플랫폼입니다. MDX나 추가 플러그인 없이 고급 Markdown 기능을 통해 콘텐츠를 저장하는 도전을 해결합니다. 프로젝트 구조는 Docs/ 디렉토리의 파일 시스템에서 직접 생성되며, 폴더가 탐색 구조를 정의합니다: 사이드바, 브레드크럼, URL이 자동으로 생성됩니다.

Example structure:

Docs/
├── welcome.md
├── [N][brain]Articles{article}/
│   ├── [C][folder-code]Development{development}/
│   │   └── [A][layers]Stack Selection{webrendering}.md
│   └── [C][signal]Tools{tools}/
│       └── [A][container]Dokploy Overview{dokploy}.md

세 계층의 계층 구조—섹션([N]), 카테고리([C]), 아티클([A])—수동 라우팅 설정 없이 슬러그, 아이콘, 제목을 제공합니다. 이는 중견/시니어 개발자를 위한 콘텐츠 유지 관리와 확장성을 간소화합니다.

Google AdInline article slot

의존성 없는 고급 Markdown

Hub는 표준 .md 파일에 직접 풍부한 블록을 도입합니다: 알림, 카드, 컬럼, 스테퍼, 다이어그램, KaTeX 수식, 테이블로부터 차트. 클래스 기반 HTML 마크업 대신 간단한 구문 구조를 사용합니다.

Example alert in HTML:

<div class="alert alert-warning" role="alert">
  <strong>Ostorozhno!</strong> Udalyonnye cherez <code>rm</code> files not popadayut in korzinu.
</div>

In Hub:

Google AdInline article slot
:::caution
Files deleted with `rm` don't go to the trash.
:::

단계별 지침 (스테퍼):

:::steps
:::step[status=done] Installation
`npm install`
:::
:::step[status=active] Setup
Fill out `.env`.
:::
:::step[status=pending] Launch
`npm run dev`
:::
:::

이 블록들은 외부 라이브러리 없이 네이티브로 렌더링되어 빌드 복잡성을 줄이고 SPA 모드에서 성능을 높입니다.

인터랙티브 테이블 및 UI 플레이그라운드

표준 Markdown 테이블이 컬럼 필터(멀티셀렉트), 하이라이팅 검색, 컬럼 숨기기, 전체 화면, 드래그 투 스크롤, Markdown/Excel 내보내기 기능을 가진 인터랙티브 컴포넌트로 변환됩니다.

Google AdInline article slot

또한 한 줄로 라이브 UI 라이브러리 컴포넌트를 임베드할 수 있습니다:

[uic:blur-text]

사용자는 스케일, 색상, 애니메이션, 속도 등의 파라미터를 동적으로 조정하며 실시간으로 결과를 확인할 수 있습니다. 별도의 플레이그라운드 없이 문서에서 컴포넌트를 데모하기에 완벽합니다.

편집을 위한 CMS 패널

내장 콘텐츠 관리 패널로 Markdown을 라이브 미리보기와 함께 편집할 수 있습니다. 인터페이스 내에서 페이지, 카테고리, 섹션을 생성하세요—npm run dev 재시작이나 스크립트 실행이 필요 없습니다. 전체 블록 형식 지원으로 완전한 CMS 같은 워크플로를 제공하지만 정적 생성으로 구동됩니다.

개발자를 위한 장점:

  • 파일 구조로부터 자동 탐색 생성.
  • 플러그인이나 MDX 없는 고급 Markdown.
  • 필터와 내보내기 지원 인터랙티브 테이블.
  • UI 컴포넌트용 라이브 플레이그라운드.
  • 미리보기 포함 CMS 스타일 에디터.

중요한 점

  • 파일 구조를 통한 탐색: [N], [C], [A] 접두사로부터 라우팅, 브레드크럼, 사이드바 완전 자동화.
  • 네이티브 Markdown 블록: 알림, 스테퍼, 컬럼, KaTeX, 차트—의존성 없음.
  • 테이블 인터랙티비티: 필터, 검색, 전체 화면, MD/Excel 내보내기.
  • UI 플레이그라운드: 파라미터와 함께 라이브 컴포넌트 데모 한 줄.
  • CMS 인터페이스: 빌드 불필요한 미리보기 편집.

— Editorial Team

Advertisement 728x90

다음 읽기