단일 저작 환경을 사용하면 다양한 도구가 필요하지 않습니다. 내장된 Git UI, 통합 빌드 도구, 자동화된 테스트, 즉시 사용 가능하고 사용자 지정할 수 있는 레이아웃을 통해 가장 중요한 부분, 즉 콘텐츠에 집중할 수 있습니다.
이제 Markdown의 장점과 의미론적 마크업의 장점을 결합할 수 있습니다. 하나의 형식만 사용하거나 의미론적 속성 및 요소, Mermaid 다이어그램, LaTeX 수학 공식을 사용하여 Markdown의 내용을 다채롭게 채우세요.
에디터에서 100개 이상의 실시간 검사는 물론 실시간 미리보기 및 빌드 중 테스트를 통해 문서 품질과 무결성을 보장합니다.
미리보기에는 독자가 보는 것과 똑같은 문서가 표시됩니다. IDE에서 단일 페이지를 미리 보거나 빌드를 실행하지 않고 브라우저에서 전체 도움말 웹사이트를 열 수 있습니다.
작은 콘텐츠부터 TOC의 전체 주제나 섹션까지 무엇이든 재사용할 수 있습니다. 필터와 변수를 활용해 유연성을 유지하세요. 복잡한 마크업 요소에 사전 정의된 템플릿을 사용하거나 템플릿을 직접 구성할 수 있습니다.
사용자 문서와 API 참조를 작성할 때 더 이상 여러 도구 사이를 이동할 필요가 없습니다. API 문서를 도움말 웹사이트에 통합하고, 동일한 레이아웃에 게시하며, 자동 생성된 참조를 수동으로 작성한 콘텐츠로 보완하세요.
이 프로젝트는 수백 회의 고객 인터뷰와 10년 이상의 IntelliJ 플랫폼 문서 작업을 거치면서 발전을 거듭했습니다. 이러한 경험을 통해 빌드해야 할 기능과 해결해야 할 문제가 무엇인지 세부적으로 파악할 수 있게 되었습니다. 이제 이러한 부분들을 하나씩 구현하려고 합니다.
도움을 주고 싶으신가요? Writerside를 사용해보고 여러분의 생각을 알려주세요!
많은 JetBrains 제품은 이미 당사의 문서 플랫폼을 사용하고 있습니다. 이제 여러분이 JetBrains의 모든 지식, 경험 및 템플릿을 사용하여 여러분의 제품에 대한 문서를 빌드할 수 있습니다.
Writerside는 현재 얼리 액세스 프로그램으로 배포되고 있으며 완전 무료입니다.
Writerside가 출시된 후에도 무료 버전이나 EAP 프로그램이 지속적으로 제공될 예정이므로 계속 무료로 도구를 사용할 수 있습니다.
Writerside에는 Markdown과 XML의 두 가지 소스 파일 형태가 있지만 하나의 형식만 고수할 필요는 없습니다. Markdown으로 작성하고 의미론적 속성 및 XML 요소와 같은 더 복잡한 요소를 삽입할 수 있습니다. 두 마크업 모두 완성 및 검증 등 완전한 에디터 지원이 제공됩니다.
기본 소스 기반이 XML로 되어 있는 경우, Markdown에서 외부 기여자의 변경 요청을 수락하고 Markdown을 XML로 변환할 수 있습니다. 마찬가지로, 예를 들어 테이블의 셀을 병합해야 하는 경우 Markdown 조각을 XML로 변환할 수 있습니다.
Markdown과 의미론적 XML 기반 마크업의 조합이 대부분의 사용 사례를 포괄할 수 있기를 바랍니다. 하지만 언제든지 피드백을 받을 준비가 되어 있으니 다른 마크업에서 제공하는 기능이 빠져 있다면 알려 주세요.
파일을 로컬에 저장할 수 있지만 Git 저장소 사용이 권장됩니다. 모든 Git 작업에 편리한 UI, 브랜치 관리, 충돌 해결을 제공합니다. Subversion 또는 Perforce와 같이 지원되는 다른 버전 관리 시스템을 사용할 수도 있습니다.
확실히 웹 기반 문서가 편리하기는 하지만 인쇄된 문서를 제작해야 하는 경우도 있을 것입니다. 2024년 1월부터 PDF 출력을 지원합니다.
Writerside를 사용하면 문서 프로젝트를 로컬로 빌드하고 .zip 파일을 생성할 수 있습니다. 그런 다음 이 파일을 웹사이트에 업로드하거나 GitHub Pages, Amazon AWS, Netlify 또는 기타 호스팅 서비스에서 호스팅해야 합니다. 향후 자체 문서 호스팅 서비스 제공을 고려하고 있습니다.
CI/CD 서버를 사용하는 경우, 문서 빌드를 구성하는 데 사용할 수 있는 Docker 컨테이너로 빌더 스크립트를 제공해드릴 수 있습니다.
Algolia 검색 색인을 생성하도록 Writerside를 구성하고 무료 Algolia 요금제에 등록할 수 있습니다.
또한 자체 검색 솔루션도 개발 중입니다.
Writerside의 초기 버전은 몇 가지 사용자 지정 옵션을 제공합니다. 다음은 수행할 수 있는 작업의 몇 가지 예입니다.
더 많은 옵션을 추가하고 문서를 더욱 유연하게 사용자 지정할 수 있게 만들 예정입니다.
Markdown 소스가 있는 경우, 이를 Writerside 프로젝트로 가져올 수 있습니다. 이와 함께 DITA를 포함한 XML 기반 형식에서 마이그레이션하는 작업을 진행 중입니다.
업데이트 정보는 정기적으로 Slack 작업 공간에 게시됩니다(가입 전에 행동 강령을 읽으세요). 또한 YouTrack에서 프로젝트를 팔로우하고 발생한 문제나 기능 요청을 보고할 수도 있습니다.
모든 주요 제품에 대한 업데이트를 발표하는 뉴스레터를 구독할 수도 있습니다.
저희와 함께하시겠어요?
JetBrains는 문서에 열정을 가지고 있으며 문서를 작성하는 사람들을 위한 최고의 도구를 만들고 싶습니다. 이 과정에서 여러분의 도움이 필요합니다. 적극 참여해 주세요!
뉴스레터 가입하기
Writerside 제품 업데이트 및 실전 문서 작성 팁을 받아 보려면 이메일을 입력하세요.