try manubot

try manubot

기타 소스코드

1.0.0

다운로드

Manubot을 사용해보십시오 :이 원고 편집 연습

원고 설명

이 저장소에는 모든 사람이 Manubot을 사용하여 연습 할 수있는 놀이터로 고안된 데모 원고가 포함되어 있습니다.

원고를 편집하려면 content 디렉토리의 파일을 변경하십시오. Getting Start 비디오에 표시된 것처럼 연필 아이콘을 사용하여 Github 웹 인터페이스로 파일을 편집 할 수 있습니다. 또는 Git 및 Github에 대한 경험이있는 경우이 저장소를 포크하고 기존의 풀 요청을 수행 할 수 있습니다.

마누봇

Manubot은 Github를 통해 학술 원고를 작성하는 시스템입니다. Manubot은 인용 및 참조, GIT를 사용한 버전 원고를 자동화하고 GitHub를 통한 공동 작업을 활성화합니다. 개요 원고는 Manubot과 함께 공동 작문의 이점과 고유 한 기능을 제시합니다. RootStock 저장소는 SETUP.md 에 자세히 설명 된 것처럼 새로운 Manubot 인스턴스를 생성하기위한 범용 템플릿입니다. 원고를 작성하는 방법은 문서에 대해서는 USAGE.md 참조하십시오.

Manubot 사용, 버그 보고서 또는 일반 문의와 관련된 질문에 대한 문제를 열어주십시오.

저장소 디렉토리 및 파일

디렉토리는 다음과 같습니다.

content 에는 마크 다운 파일과 인용 및 참조 입력이 포함 된 원고 소스가 포함되어 있습니다. 자세한 내용은 USAGE.md 참조하십시오.
output 에는 결과 원고를 포함하여 Manubot의 출력 (생성 파일)이 포함됩니다. 이 파일을 덮어 쓰기 때문에이 파일을 수동으로 편집해서는 안됩니다.
webpage 는 HTML 원고를보기위한 정적 웹 페이지로 렌더링되는 디렉토리입니다.
build 에는 원고 구축을위한 명령 및 도구가 포함되어 있습니다.
ci 에는 연속 통합을 통해 배포에 필요한 파일이 포함되어 있습니다.

로컬 실행

Manubot을 실행하는 가장 쉬운 방법은 지속적인 통합을 사용하여 콘텐츠가 변경 될 때 원고를 재건하는 것입니다. Manubot 원고를 현지에서 구축하려면 build 에 설명 된대로 콘다 환경을 설치하십시오. 그런 다음이 루트 디렉토리에서 다음 명령을 실행하여 Posix 시스템에서 원고를 작성할 수 있습니다.

 # Activate the manubot conda environment (assumes conda version >= 4.4)
conda activate manubot

# Build the manuscript, saving outputs to the output directory
bash build/build.sh

# At this point, the HTML & PDF outputs will have been created. The remaining
# commands are for serving the webpage to view the HTML manuscript locally.
# This is required to view local images in the HTML output.

# Configure the webpage directory
manubot webpage

# You can now open the manuscript webpage/index.html in a web browser.
# Alternatively, open a local webserver at http://localhost:8000/ with the
# following commands.
cd webpage
python -m http.server

때로는 컨텐츠 디렉토리를 모니터링하고 변경 사항이 감지 될 때 원고를 자동으로 재 구축하는 것이 도움이됩니다. 다음 명령은 실행 중에 build.sh 스크립트와 manubot webpage 명령을 모두 트리거합니다.

bash build/autobuild.sh

지속적인 통합

풀 요청이 열릴 때마다 CI (Continuous Integration)는 변경 사항이 빌드 프로세스를 중단하여 형식의 원고를 생성하는지 여부를 테스트합니다. 빌드 프로세스는 잘못된 인용과 같은 일반적인 오류를 감지하는 것을 목표로합니다. 풀 요청 빌드가 실패하면 고장 원인에 대한 CI 로그를 참조하고 그에 따라 풀 요청을 수정하십시오.

main 분기에 대한 커밋이 발생하면 (예 : 풀 요청이 병합 될 때) CI는 원고를 작성하고 결과를 gh-pages 및 output 분기에 씁니다. gh-pages 브랜치는 GitHub 페이지를 사용하여 다음 URL을 호스팅합니다.

https://manubot.github.io/try-manubot/ html 원고
PDF 원고 (https://manubot.github.io/try-manubot/manuscript.pdf)

지속적인 통합 구성 세부 사항은 .github/workflows/manubot.yaml 참조하십시오.

특허

달리 언급 된 경우를 제외하고,이 저장소 전체는 CC에 따라 4.0 라이센스 ( LICENSE.md )에 의해 라이센스가 부여되므로 속성과의 재사용이 가능합니다. https://github.com/manubot/try-manubot에 링크하여 귀속하십시오.

CC By는 코드 및 데이터에 이상적이지 않기 때문에 CC0 1.0 퍼블릭 도메인 전용 ( LICENSE-CC0.md )에 따라 특정 저장소 구성 요소가 해제됩니다. 다음 글로벌 패턴과 일치하는 모든 파일은 CC에 따라 이중 라이센스가 4.0 및 CC0 1.0입니다.