도큐사우루스 문서 사이트 만들기 - 1. 소개

위키나 블로그도 좋은데, 좀 더 체계적으로 기술적인 자료나 매뉴얼들을 적어두는 온라인 문서 사이트를 하나 만들어 보자. 비용이 문제가 되지 않게 무료로 사용하면 좋을 듯 하여 GitHub Pages 기술을 활용해서 자동 배포 되도록 진행할 예정이다.

마크 다운 글을 쓰는 것만으로 나만의 문서 사이트, 위키 사이트를 만들 수 있도록 해주는 도큐사우르스를 활용할 예정이다. 도구를 만드는 것이 제일 무식한 방법이니깐 꼭 잘 활용하도록 하자!

 

설치 부터 운영까지의 내용을 아래와 같이 정리하고 있다.

2024.01.02 - [디지털노마드] - 도큐사우루스 문서 사이트 만들기 - 1. 소개

2024.01.03 - [디지털노마드] - 도큐사우루스 문서 사이트 만들기 - 2. 설치 혹은 GitHub Fork로 복사

2024.01.03 - [디지털노마드] - 도큐사우루스 문서 사이트 만들기 - 3. GitHub Actions 빌드 및 브랜치 생성

2024.01.03 - [디지털노마드] - 도큐사우루스 문서 사이트 만들기 - 4. GitHub Pages 배포 자동화

2024.01.03 - [디지털노마드] - 도큐사우루스 문서 사이트 만들기 - 5. GitHub Pages 도메인 연동하기

2024.01.11 - [도큐사우루스] - 도큐사우루스 문서 사이트 만들기 - 6. 다국어 처리

도큐사우루스 개요

요즘 유행하는 노션 같은 툴로 정리하는 것도 좋지만, 좀 더 정제된 웹 페이지의 형태로 관리하는 것이 문서화 사이트로는 나아 보인다. 그래서 찾은 것은 페이스북 문서 관리 시스템으로 유명한 도큐사우루스 이다. 도큐사우루스(Docusaurus)는 문서화를 쉽게 만들어주는 정적 사이트 생성 도구입니다.  리액트 기반의 정적 사이트 생성기의 일종으로 볼 수 있는데 매뉴얼이나 문서 목차관리, 블로그 기능까지 포함된 아주 거대한 무료로 구축할 수 있는 문서 시스템이다. Vercel, GitHub Pages, Netlify, Render, Surge와 같은 다양한 정적 사이트 호스팅 서비스에 배포할 수 있습니다. 무료로 활용하기 위해 GitHub Pages 를 통한 배포까지로 마무리 해보려 한다.

 

2023.10에 3.0 릴리즈가 되었네 무조건 최신버전을 사용해야지

공식 페이지는 여기 => https://docusaurus.io/

Build optimized websites quickly, focus on your content | Docusaurus

문서 사이트는 아래와 같이 바로 사용할 수 있고, 혹시나 약간 변형해서 개인 페이지, 랜딩 페이지로도 활용할 수 있을 것 같습니다.설치가 완료되면 아래와 같은 사이트의 모습을 볼 수 있다.

도큐사우루스 장점

⚡️ Docusaurus will help you ship a beautiful documentation site in no time.

아주 쉽게 문서 사이트를 구축할 수 있다. 온라인으로 배포하지 않고 로컬로 사용한다면 진짜 5분이면 구성할 수 있다.

💸 맞춤형 기술 스택을 직접 구축하는 것은 많은 비용이 듭니다. Instead, focus on your content and just write Markdown files.

💥 더 많은 기능이 필요한가요? Use advanced features like versioning, i18n, search and theme customizations.

💅 Check the best Docusaurus sites for inspiration and read some testimonials.

🧐 Docusaurus is a static-site generator. It builds a single-page application with fast client-side navigation, leveraging the full power of React to make your site interactive. It provides out-of-the-box documentation features but can be used to create any kind of site (personal website, product, blog, marketing landing pages, etc).

도큐사우루스

 

도큐사우루스 레퍼런스

이 플랫폼을 활용한 레퍼런스는 아래와 같다.

List of websites people are building with Docusaurus

https://docusaurus.io/showcase

Docusaurus Site Showcase | Docusaurus

(보강)

 

Fast Track ⏱️​

5분만에 만들어 보기 도전

아래 명령을 수행하면 저절로 된다. 단, Node.js 를 18 이상 설치해 줘야 한다.

Install Node.js and create a new Docusaurus site:

npx create-docusaurus@latest my-website classic

 

Start the site:

cd my-website
npx docusaurus start

 

Open http://localhost:3000 and follow the tutorial.

마무리

지금까지 온라인 문서 시스템을 무료로 구축하기 위해 일단 도큐사우루스라는 플랫폼을 알아보았다. 다음편 부터는 실제 운영 사이트를 설치해서 배포하는 방법을 알아보자.