qiita_org manual

7877 단어 qiita_orgGemsRuby
! Mac OS X-10.13.3 ! ruby-2.7.0p0
다음은 Qiita에 Org-mode 텍스트를 투고하는 데 사용되는 gem qiita_org의 설치부터 명령을 쓰는 방법을 설정하는 manual입니다.

사용 방법


설치


terminal에서gem를 사용하여 설치할 수 있습니다.
> gem install qiita_org
설치 후 동작 확인을 진행합니다.
    > qiita
Commands:
  qiita all [teams/public/private] [options]    # post all org files in the d...
  qiita config [global/local] [option] [input]  # set config
  qiita get [qiita/teams] [ITEM_ID]             # get qiita report
  qiita help [COMMAND]                          # Describe available commands...
  qiita list [qiita/teams]                      # view qiita report list
  qiita post [FILE] [private/public/teams]      # post to qiita from org
  qiita say_hello                               # say_hello
  qiita template                                # make template.org
  qiita upload [FILE] [teams/public/private]    # upload about image to qiita
  qiita version                                 # show version
이렇게 명령 일람을 표시하면 설치가 완료됩니다.

설정 방법


Qiita에 글을 투고하는 절차qiita_org를 설치해야 할 뿐만 아니라 명령으로 설정 파일을 만들어 다음과 같은 설정을 해야 한다.
  • pandoc를 설치합니다
  • 이름, 이메일 주소 등록
  • Qiita의 방문 영패를 획득하고 로그인합니다
  • Qiita: Team의 URL에 로그인합니다
  • 우선pandoc라는 마크다운의 텍스트를 Org-mode의 텍스트로 바꾸는 패키지를 사용했기 때문에 이 소프트웨어를 설치합니다.
    //macの場合//
    > brew install pandoc
    
    //ubuntuの場合//
    > sudo apt update
    > sudo apt install pandoc
    
    이어서 HOME 디렉토리에서 설정 파일을 만듭니다.
    > qiita config global
    
    다시 한 번 똑같이 실행하여 복사된 설정 파일의 모형을 확인합니다.
    > qiita config global
    /Users/kentayamamoto/Github/yamatoken/.qiita.conf
    
    "name": ""
    "email": ""
    "access_token": ""
    "teams_url": ""
    "display": "open"
    "ox_qmd_load_path": "~/.emacs.d/site_lisp/ox-qmd"
    
    다음은 이름과 이메일 주소를 로그인합니다.
    > qiita config global name 'Your Name'
    > qiita config global email '[email protected]'
    

    Qiita의 웹 사이트에서 상기 이미지와 같이 조작하여 필요한'역할역'에 검사를 넣고 발행합니다. 페이지를 이동하면 개인용 방문 영패 표시줄에 발행된 방문 영패를 표시합니다. 이를 복사하여 아래와 같이 실행합니다.
    > qiita config global access_token 'コピーしたアクセストークン'
    
    마지막으로 Qiita:Taem에 속한다면,
    > qiita config global teams_url 'https://hoge.qiita.com/'
    
    등기를 집행하다.
    또한 여러 팀에 속하거나 디렉터리마다 메일 주소를 설정하려면local의 설정 파일을 지정할 수 있습니다. 설정 파일을 만들고 싶은 디렉터리에서
    > qiita config local set
    
    이후 상술한 설정과 똑같이 쓰면local의 투고를 설정할 수 있습니다.

    명령 사용


    post


    Qiita에 기사를 투고하는 데 사용되는 명령입니다.
    명령은 "qiita post [투고하고 싶은 파일] [option]"입니다.
    예를 들어, hoge.org라는 파일을 공개 보도로 투고하기 위해 다음과 같이 집행합니다.
    > qiita post hoge.org public
    
    option에는'public','private','teams'가 있는데 각각 공개 보도에 대해 한정 공유보도, Qiita:Team의 투고가 있다.
    또한 이미 투고된 기사의 Org-mode 텍스트에 기사 ID가 기재된 내용에 대해서는 옵션을 생략하고 맨 위에 기재된 ID에 투고할 수 있습니다.
    별표와xargs 등을 사용하는 여러 파일의 투고도 지원합니다.
    > qiita post hoge*.org private
    > ls -1 hoge*.org | xargs qiita post
    
    실행할 때 hoge가 있는 파일을 한 번에 투고할 수 있습니다.

    upload


    Org-mode 텍스트에 그림과 사진을 Qiita에 표시하는 명령입니다.
    명령은 "qiita upload [투고하려는 파일][option]"입니다.
    옵션은post 명령과 같습니다.

    웹 페이지에 표시된'편집'을 클릭하여 편집 화면으로 이동합니다.

    상술한 작업을 마친 후 단말기에서
    Overwrite file URL's on test2.org? (y/n)
    
    따라서'y'를 누르면 Org-mode 텍스트에 URL이 기록되고 나중에 기사를 투고할 때 업로드를 하지 않아도 표시됩니다.

    template


    Qiita 투고용 제목이 기재된 Org-mode 텍스트 템플릿을 가져오는 명령입니다.
    명령은'qiita template [파일 이름]'입니다.
    실행하면 OS 정보와 루비 버전이 기록되어 있는지 묻는 메시지가 나타납니다. ''n'에 기재되지 않도록 지정하려면 y'를 입력하십시오.
    파일 이름을 지정하면 이 파일 이름에 따라 Org-mode 텍스트를 만듭니다. 지정하지 않으면'template입니다.org'가 만들어졌다.

    get


    명령을 실행하는 디렉터리에 Qiita의 기사를 Org-mode 텍스트로 저장하기 위한 명령입니다.
    명령은'qiita get[qiita/teams][보도된 ID]'입니다.
    옵션은 qiita 또는 팀으로 각각 Qiita의 보도를 지정할 수 있으며, Qiita:Team의 보도를 얻을 수 있습니다.
    보도의 ID를 지정하면 해당 ID와 동일한 보도를 얻을 수 있습니다.
    ID는 Qiita 웹 URL의 맨 끝에 있는 문자열입니다.
    예를 들어'https://qiita.com/yamatoken/private/hogehogehoge'의'hogehoge'의 부분.
    ID에 대한 지정이 없으면 option에서 지정한 글의 제목을 순서대로 표시하고 취득 여부를 선택할 수 있습니다.
    얻은 기사는'id.org'로 목록에서 작성되었다.

    list


    qiita에 있는 기사의 제목과 URL을 표시하는 명령입니다.
    명령은'qiita list[qiita/teams]'입니다.
    옵션을'qiita'로 지정하면 Qiita에 있는 자신의 기사가 최신부터 100건, 팀인 경우 Qiita:Team의 모든 기사가 최신부터 100건 표시됩니다.

    all


    디렉토리에 있는 모든 Org 파일을 Qiita에 투고하는 데 사용되는 명령입니다.
    "qiita all"을 실행하면 모든 Org 파일을 파일 내 ID의 기록에 따라 투고합니다. ID가 기록되지 않은 파일은 한정된 공통 보도로 새 투고합니다.
    옵션의 지정도 가능합니다.post,upload 역시public,private,teams를 선택할 수 있습니다. 선택할 때 지정된 장소에서만 투고할 수 있습니다.
    또한'-exclude'와 변수를 사용하여 파일을 지정하면 이 파일을 제외하고 다른 모든 파일을 투고합니다. 예를 들어 여러 Org 파일에서'hoge'를 사용합니다.org'만 투고하고 싶지 않은 상황에서
    > qiita all --exclude hoge.org
    
    별표 등을 사용하여 여러 파일을 제외할 수도 있습니다.

    config


    'qiita_org'설정 파일을 사용하는 명령을 설정합니다. 설정 방법은 상기'설정 방법'과 같습니다.
    > qiita config [global/local]
    
    실행하면 현재 설정된 내용을 확인할 수 있습니다.

  • source ~/Github/yamatoken/qiita_org_manual/qiita_org_manual_final.org
  • 좋은 웹페이지 즐겨찾기