Simpesys

Simpesys는 디지털 정원을 구축하기 위한 파일 기반 문서 빌드 도구이자, 문서 시스템 그 자체다. "Simpesys"라는 이름은 "Simonpedia"와 "system"의 합성어이며, /sɪmˈpesɪs/로 발음한다.

시작하기

Simpesys CLI 도구를 사용하면 쉽게 디지털 정원을 구축할 수 있다.

$ deno run -R -W -E jsr:@simpesys/cli init my-garden
$ cd my-garden
$ deno task start

위 명령을 실행하면 브라우저에서 디지털 정원을 확인할 수 있다.

Simpesys를 이용해 디지털 정원을 구축하는 자세한 과정은 시작하기 문서에서 소개한다.

아키텍처

Simpesys는 크게 세 개의 레이어로 구성되어 있다. 사용자 공간은 사용자가 Simpesys 프로젝트를 구축하고, 문서를 편집하고, 애플리케이션과 직접 상호작용하는 레이어다. Simpesys 코어는 문서 시스템의 핵심 컴포넌트를 정의하고, Simpesys 프로젝트의 빌드 파이프라인을 구현하는 레이어다. 이러한 핵심 로직은 @simpesys/core 패키지로 배포된다. 마지막으로 애플리케이션은 사용자 공간과 Simpesys 코어 사이를 잇는 레이어다. 애플리케이션은 실제로 사용자가 문서 시스템과 상호작용할 수 있는 인터페이스이자, 문서를 담고 있는 Simpesys 프로젝트 그 자체다. 그래서 애플리케이션은 사용자 공간에 속해 있다고 할 수 있다. 애플리케이션의 진입점은 app/main.ts 파일이다.

Simpesys 아키텍처에 관한 더 자세한 내용은 아키텍처 문서에서 설명한다.

설계 원칙

Simpesys는 기본적으로 전체 문서 시스템을 트리로 모델링한다. 하지만 각 문서는 상호 참조가 가능하기 때문에 문서의 위계 모델은 트리이지만, 참조 모델은 서킷(circuit)이 존재하는 연결 유향 그래프가 될 수 있다. 이러한 구조를 통해 심페시스는 전체적인 문서 구조를 간소하게 유지하면서도 문서 간의 복잡한 참조 관계를 관리할 수 있다. Simpesys를 초기화하면 지정된 루트 마크다운 문서를 읽는다. 루트 문서를 시작으로 내용에 포함된 내부 링크 문법을 파싱해 연결된 다른 문서를 읽는 과정을 반복하며 전체 문서 트리를 구축한다. Simpesys는 이렇게 문서 트리를 만들고, 이 문서 트리를 다루는데 필요한 API를 제공한다.

문서 중심 설계

Simpesys는 문서에만 관심을 갖는다. 문서 디렉토리에 포함된 각 마크다운 파일은 하나의 문서를 나타낸다. 모든 문서는 루트 문서로부터의 유일한 상대 경로로 식별되며, 평면 또는 계층적 구조를 가질 수 있다. Simpesys는 루트 문서와 연결된 모든 내부 링크를 문서로 취급한다. 특정 문서가 없음을 표현하기 위해 필요한 페이지를 찾을 수 없음 문서도 예외적으로 취급하지 않으며, 루트 문서의 일반적인 하위 문서다.

높은 연결성

Simpesys는 문서간 연결성을 강화해야 한다. 디지털 정원의 핵심은 문서와 문서 사이의 높은 연결성이다. 특정 문서로부터 다른 문서로 향하는 거리를 짧게 만드는 것이 디지털 정원을 관리하며 지속적으로 달성해야 하는 목표다. 문서가 축적될수록 거대한 숲에서 나만의 길을 내는 것이 중요해지며, 사용자는 자신이 내어 놓은 길을 산책하며 자연스럽게 새로운 영감을 얻을 수 있어야 한다. 디지털 정원은 객관적인 지식을 보존하는 위키가 아니다. 디지털 정원이 개인 위키가 되는 순간, 집단지성이 사라진 위키피디아로 전락한다.

애플리케이션 레이어 분리

Simpesys 그 자체로는 정적 사이트나 웹 애플리케이션을 만드는 도구가 아니다. Simpesys의 목표는 문서 시스템을 구조화하고, 그 구조를 다루기 위한 API를 제공하는 것이다. Simpesys는 초기화 과정에서 마크다운을 HTML로 변환하지만, 이는 애플리케이션을 만들기 위한 과정이라기보다는 표준화된 방식으로 문서를 표현하기 위한 중간 레이어을 두는 것에 가깝다. 애플리케이션 구현은 사용자의 몫이며, Simpesys는 애플리케이션 구현을 위한 어떠한 종속성도 갖지 않는다.

좁고 깊은 모듈

Simpesys가 사용자에게 제공하는 모듈의 인터페이스는 좁고, 기능의 깊이는 깊어야 한다. Simpesys는 필수적인 API만을 공개하며, 사용자가 내부 동작을 커스텀하려면 사전에 정해진 옵션 값으로만 설정할 수 있다. Simpesys는 "설정보다 관례"를 따라 모든 설정 옵션에 합리적인 기본값을 제공한다.

하위문서

• 시작하기
• 아키텍처
• 설정
• 기능
• 쇼케이스

다른 언어

• English

그 외

• 페이지를 찾을 수 없음

라이선스

Simpesys는 GNU General Public License v3.0에 따라 배포된다.

외부링크

• GitHub: https://github.com/pakrsb/simpesys
• JSR: https://jsr.io/@simpesys

Backlinks

• Simpesys

  • 한국어