안녕하세요, HN 커뮤니티에 SmallDocs (https://sdocs.dev)를 소개하고자 합니다. SDocs는 마크다운 파일을 즉각적이고 100% 프라이버시가 보장되는 방식으로 우아하게 미리 보고 공유할 수 있는 CLI(Command Line Interface) 및 웹 앱입니다. (코드: https://github.com/espressoplease/SDocs)
우리가 커맨드 라인 기반 에이전트(agent)를 사용하면서 .md 파일의 비중이 점점 높아지고 있습니다. 이 파일들은 에이전트가 생성하기에는 훌륭하지만, 인간에게는 약간 불편합니다. 마크다운 파일은 읽거나 미리 보기에는 다소 번거롭고, 공유하거나 받는 과정도 까다롭습니다. SDocs는 이러한 문제점들을 해결하기 위해 제작되었습니다.
sdoc path/to/file.md를 실행하면 (먼저 npm i -g sdocs-dev로 설치해야 함), 브라우저에서 즉시 미리 보기(원하는 대로 보이도록 기본 스타일링 적용)가 가능하며, 바로 URL을 공유할 수 있습니다.
우리가 사용하는 에이전트들이 생성하는 .md 파일에는 코드베이스 정보, 해결되지 않은 버그, 프로덕션 로그 등 우리가 가진 가장 민감한 정보들이 담겨 있습니다. 이러한 이유로 100% 프라이버시 보호는 SDocs의 필수 구성 요소입니다.
이를 달성하기 위해 SDoc URL은 마크다운 문서의 내용을 압축된 base64 형태로 URL의 fragment(해시 기호 # 뒤의 부분)에 포함합니다. 예: https://sdocs.dev/#md=GzcFAMT...(여기에 문서 내용이 들어감...)
URL fragment의 장점은 서버로 전송되지 않는다는 것입니다 (참고: https://developer.mozilla.org/en-US/docs/Web/URI/Reference/Fragment: "The fragment is not sent to the server when the URI is requested; it is processed by the client").
sdocs.dev 웹 앱은 URL fragment에 저장된 내용을 클라이언트 측에서 디코딩하고 렌더링하는 엔진일 뿐입니다. 이는 문서의 내용이 사용자 본인과 공유를 선택한 사람에게만 머무른다는 의미이며, SDocs 서버는 이 내용에 접근하지 않습니다. (직접 코드를 검사하거나 에이전트에게 검사를 요청하여 확인해 보세요!)
.md 파일은 미래 업무 방식에서 큰 역할을 할 수 있기 때문에, SDocs는 마크다운 파일 내의 스타일링 및 흥미로운 콘텐츠 렌더링 경계를 넓히고자 합니다. 아직 더 많은 작업이 남아있지만, 시작으로 복잡한 스타일을 추가하고 차트를 시각적으로 렌더링할 수 있습니다. SDocs 루트(기본 스타일로 sdoc.md를 렌더링)에는 흥미로운 예시가 담긴 이미지와 링크들이 있습니다. sdoc schema 및 sdoc charts는 사용자 또는 에이전트에게 SDocs의 포맷팅을 최대한 활용하는 방법에 대한 자세한 정보를 제공합니다.
SDocs URL을 공유하면, 스타일도 함께 전달됩니다. 왜냐하면 YAML Front Matter - https://jekyllrb.com/docs/front-matter/ - 형태로 마크다운 파일에 추가되기 때문입니다. 예:
styles:
fontFamily: