OSD600 블로그 #2 - 릴리스 0.1

3518 단어
OSD600의 첫 번째 릴리스(CLI 정적 사이트 생성기 개발)의 경우 Node.js를 사용하여 "commander" npm module을 활용하여 프로그램을 구현하기로 결정했습니다.

프로그램의 소스 코드는 찾을 수 있습니다here..

프로그램에 구현한 선택적 기능은 다음과 같습니다.
  • 입력에서 제목을 구문 분석하여 ... 태그를 채우고 웹 페이지 상단에

    ...

    을 생성하는 기능.
  • 사용자가 생성된 모든 HTML 파일에 적용할 스타일시트 URL을 지정할 수 있습니다.
  • 하위 폴더의 텍스트 파일에서 HTML 파일을 생성하기 위해 입력 폴더의 재귀 검색을 허용합니다.

  • 텍스트 파일에서 생성된 HTML 파일의 예를 찾을 수 있습니다here.

    모든 피드백에 감사드립니다!

    개요



    이 도구를 통해 사용자는 다음을 수행할 수 있습니다.
  • HTML 웹 페이지로 변환하려면 ".txt"파일을 지정하십시오
  • .
  • 모든 파일을 HTML 웹 페이지로 변환하려면 여러 개의 ".txt"파일이 포함된 폴더를 지정하십시오. 프로그램은 하위 폴더에서 ".txt"파일도 재귀적으로 검색합니다.

  • 설치



    이 프로그램을 설치하려면 먼저 저장소git clone를 설치하십시오.

    그런 다음 새로 생성된 폴더 내에서 터미널을 열고 npm install -g 를 실행합니다.

    이 명령은 시스템에 전역적으로 프로그래밍을 설치합니다.

    옵션



    사용자가 이 CLI 프로그램과 함께 사용할 수 있는 네 가지 옵션이 있습니다.


    짧은 형식
    긴 형식
    설명


    -V
    --버전
    프로그램의 현재 버전을 출력합니다.

    -시간
    --돕다
    프로그램 사용법을 설명하는 도움말 메시지를 출력합니다.

    -나
    --입력
    사용자가 단일 .txt 파일 또는 .txt 파일이 포함된 폴더를 지정할 수 있습니다.

    -에스
    --스타일시트
    사용자가 생성된 HTML 파일에 적용할 CSS 스타일시트가 포함된 URL을 지정할 수 있습니다.


    용법



    현재 버전



    프로그램의 현재 버전을 확인하기 위해 사용자는 다음을 실행할 수 있습니다.
    rohan-ssg -v 또는 rohan-ssg --version
    다음이 출력됩니다.
    The current version is: x.x.x

    돕다



    프로그램을 설명하는 메시지를 보려면 다음을 실행할 수 있습니다.
    rohan-ssg -h 또는 rohan-ssg --help
    다음이 출력됩니다.

    This program is used to generate a static HTML web page from a given .txt file OR a folder containing .txt files.
    The following options are available: 
        -v, --version: current program version
        -h, --help: program instructions
        -i, --input: path input folder or file to be converted to HTML. Note that folders are recursively searched for .txt files.
        -s, --stylesheet: stylesheet url to be used in the HTML file
    
        The files will be saved in a '/dist' folder in the same directory as the input file/folder.
    
        For example, to generate a single HTML file from a .txt file with a specific stylesheet URL, use the following command:
        rohan-ssg -i .PATH/TO/FILE/input.txt -s https://example.com/stylesheet.css
    


    입력(스타일시트 포함 및 제외)



    특정 파일에 대해 사용자는 다음을 실행할 수 있습니다.
    rohan-ssg -i PATH/TO/FILE/example.txt 또는 rohan-ssg --input PATH/TO/FILE/example.txt
    그러면 생성된 HTML 파일을 포함하는 /dist 디렉토리가 생성됩니다.

    폴더의 경우:
    rohan-ssg -i PATH/TO/FOLDER 또는 rohan-ssg --input PATH/TO/FOLDER
    위와 유사하게 이것은 지정된 폴더(하위 폴더 포함) 내의 모든 .txt 파일에서 생성된 모든 HTML 파일을 포함하는 /dist 디렉토리도 생성합니다.

    모든 HTML 파일에 적용할 스타일시트를 지정하려면 다음과 같이 -s 또는 --stylesheet 옵션을 사용하도록 선택할 수 있습니다.
    rohan-ssg -i PATH/TO/FOLDER -s https://example.com/stylesheet.css 또는 rohan-ssg -i PATH/TO/FILE/example.txt -s https://example.com/stylesheet.css
    이렇게 하면 지정된 스타일시트(URL이어야 함)가 생성된 모든 HTML 파일에 연결됩니다.

    좋은 웹페이지 즐겨찾기