본문 바로가기

IT/Web

기술 자료나 위키 문서를 외부에 공개할 때 사용할 문서 플랫폼

세로 광고판 입니다

기술 자료나 위키 문서를 외부에 공개할 때 사용할 문서 플랫폼들

이제껏 위키 같은 솔루션을 최대한 활용하거나,

Wordpress 같은 블로깅 플랫폼을 최대한 활용해 보려고 하지만,

이런 요구들이 여기저기 있는 것 같네. 많은 플랫폼 들이 있다.

개인적인 용도로 정리하고 있는 것이니, 객관적인 시각으로 보시지 마시길...

플랫폼 조사 내용

  • 현재 도쿠위키

    • 쉽게 설치해서 사용할 수 있으나, 갈수록 활용도나 유지보수에 어렵고
    • 글을 쓰는 에디터나 문법이 로컬룰이라 관리나 생성이 어려움이 많고,
    • 기타 인터페이스도 너무 고전적이고 첨부파일등 우리가 별도의 서버로 관리를 계속하기가 어려움
  • GitHub pages 제한 사항

    github page limit
  • https://www.docsy.dev/docs/

    • 구글에서 제공하고 있는 Hugo 문서 플랫폼 테마
    • 구글에서 사용했다는 것이 장점, 물론 예제 사이트나 프로젝트 사이트 수준이지만,
    • Hugo가 대중화가 되었다는 점에서 장점을 가질 수 있다.
    • go 언어 기반, 빠르다고들 하네…
  • https://www.docz.site/

    • 깔끔하니 문서 집중
    • 기본 테마가 보기 좋게 구성되어 있다.
    • 그런데 md 파일이 아니라 약간 custom 된 mdx 를 렌더링 하네..일단 섞인 것은 찝찝
  • https://v2.docusaurus.io/

    • 문서 블로그 간단한 홈페이지 기능까지 다 할 수 있는 토탈 솔루션
    • 세팅 및 동작 활용법만 익히면 딱 맞는 솔루션 같긴 한데 진입 장벽이 높네요~
    • 랜딩페이지나 전체 사이트 구성에 약간씩 손이 가야 한다.
  • https://readthedocs.org

    • 오픈소스-커뮤니티 버전
    • 아래 같은 유사한 툴들을 좀 더 찾아보고 비교해서 판단해 보면 좋은데, 일단은 내 지식에서 찾은 것은 아래 솔루션. (채용되는 FE 전문가가 의견을 주면 더 좋고. :) )
    • https://docs.espressif.com/projects/esp-idf/en/latest/ 도 보니깐 같은 솔루션을 이용하고 있네.
    • 자체 호스팅이 있으면 오픈소스 버전을 설치하고, 안되면 아래 비즈니스(클라우드) 버전을 써야할 듯, 우리가 쓰는 정돈 큰 무리 없어 보입니다. 한 번 설치하고, wizwiki.net 내용을 가져와서 운영해 보는 것을 프로젝트로 진행시켜도 되고 혹은, 우리가 문서 시스템을 설치 및 업데이트 머 이런걸 고생하지 않고도 할 수 있는 플랫폼은 여기인듯 한데,
  • https://readthedocs.com/

    • 클라우드 버전, 그냥 글만 쓴다.
    • discourse 플랫폼을 이용하고 있는 포럼처럼 플랫폼 업체에 운영을 맡긴다.
      • 운영상, 이게 가장 안정적이긴 하다. 돈으로 몸이 편해진다.
      • 당연히 돈 주고 서비스를 써야 할 듯한데, 비즈니스 버전은 https://readthedocs.com/features/
    • 커스텀 도메인 넣고 하려면, 좀 비싸도, 월 150불 짜리 Advanced 플랜을 사용하면 될 것 같다.
      • 좀 비싸긴해 ??
    • 오픈소스 버전이 정 어렵다고 하면, 30일 Trial을 쓸 수 있는 기회가 있는데, 우리 위키 내용을 옮겨와 보면 어떨까?
    • 막상 옮겨놓고 보면 쓸수 있을 지 그만 할지 결정하는데 더 쉬울 것 같긴한데..
  • https://www.mkdocs.org/ - MKDocs 플랫폼

    • 오픈소스, 무료로 설치해서 활용 가능

    • 정적 사이트 생성기의 일종으로 문서쪽에 특화되어 있음

    • 따라서, 클라우드 버전은 모르겠으나, GitHub을 이용한 사이트 운영은 가능할 듯

    • 매번 md 파일이 변경되면 정적 사이트 생성기를 통해 업데이트 해 줘야 하는 번거로움이 있지만 독립 호스팅의 부담은 줄어듬

      • Git으로 관리되니깐 누구나 생성해서 업로드 가능, 버전관리는 당연히 되니깐..

Dream big from https://unsplash.com/photos/U2eUlPEKIgU