9월 세일을 시작합니다! 9월 25일(미국 동부시간)까지 엄선된 콘텐츠를 50% 할인받으세요!

README

평점 없음

Project documentation in the Unreal Editor

  • 지원 플랫폼
  • 지원 엔진 버전
    4.26 - 4.27, 5.0
  • 다운로드 유형
    엔진 플러그인
    이 제품은 코드 플러그인과 함께 미리 빌드한 바이너리와 언리얼 엔진에 통합되는 모든 소스 코드를 포함하고 있으며 원하시는 엔진 버전에 설치하여 프로젝트에 따라 활성화할 수 있습니다.

Overview


README is an Unreal plugin intended to make it easier to access project documentation from within the Unreal editor. It can interpret basic markdown syntax and display it in the README editor tab.


Why use it


The README project documentation tool provides quick and easy access to your projects documentation from within the editor. This allows the documentation to be easily accessible without requiring a context switch out of the Unreal Editor and into a Browser etc, it also allows documentation to be included in source control. It is designed to minimize interruptions to the development flow and by having project documentation accessible right there in the editor it will feel like you haven't stopped coding at all.





기술적 세부사항

How to use it

It all starts with a README.md file in the root of your project. From here you can link to other markdown pages within your projects file hierarchy using standard markdown hyperlinks.


Markdown Support

Currently the following markdown tags are supported:

Headers

  • Header one      #
  • Header two      ##
  • Header three     ###
  • Header four      ####
  • Header five      #####
  • Header six      ######

Formatting

  • Bold           **Bold**
  • Italic           _Italic_
  • Bold Italic      _**Bold Italic**_
  • Strike through   ~~StrikeThrough~~
  • Inline code    ```some code```

Other

  • Images           ![Image Title](project/relative/path/to/image.png)
  • Links             [link Title](project/relative/path/to/page.md)
  • Horizontal line      ___

Code Modules:

  •  README (editor)