[RUBY] I made a gem to post the text of org-mode to qiita

Introduction

qiita \ _org is a gem that posts text written in emacs org-mode to Qiita. I created it based on the idea that it would be nice if cui could be used to create and post articles.

This article describes a usage example of qiita \ _org, how to install and initialize it. Please refer to https://qiita.com/yamatoken/items/9314161758e778fd82c0 for the command of qiita \ _org.

Note: Since command \ _line is used, please set the ruby version to 2.4.0 or higher. We also recommend emacs version 26.3 or higher.

In windows, we have confirmed the operation in the following environment.

However, please enter'n'on MacOS when executing qiita template.

Example of use

First, get the post template of org-mode. Type'qiita template', decide whether to write the environment, and create template.org. 

Then, such an org is created. 

Change the title and tag here to those for putting on qiita, and then just write the text as before.

Once the text is created, all you have to do is execute the posting command. When I try to post to the limited shared post, it looks like this. 

It will appear sloppy, but if the settings are done properly, the posting will be completed and the page posted in Safari will open.

The posted article will show you in which directory the original org text is located as Source, which should be useful even if you want to edit a previous article. .. ..

Installation method

gem install qiita_org

If qiita and the list of commands are displayed, the installation is completed successfully.

Initial setting

install pandoc

on mac

brew install pandoc

ubuntu

sudo apt update
sudo apt install pandoc

Creating a configuration file

qiita config global

And create a configuration file in your home directory.

How to create Qiita access token and write to configuration file

At https://qiita.com/settings/applications

Click'Issue a new token'for your personal access token. 

Write a description of the access token, and check all the scopes as shown in the image. Then issue it. 

When the page moves, the access token is displayed in the personal access token, so copy it. (Please note that this character string cannot be displayed again when the page is moved.)

Return to the terminal and execute as follows.

qiita config global access_token 'your accesstoken'

Paste the access token you copied earlier in place of'your access token'.

Name registration

qiita config global name 'your name'

Email address registration

qiita config global email 'your email'

Qiita Team URL registration

It is necessary to use the option called'teams', so if you have a Qiita Team to which you belong, please do this setting. If not, you don't have to set it.

qiita config global teams_url 'https://foge.qiita.com/'

Be careful not to forget to add a'/' at the end of the URL.

ox-qmd settings

See the article below for more information on ox-qmd. Reference: I made a package to export Qiita compliant Markdown from Org-mode

https://github.com/0x60df/ox-qmd ox-qmd.el'~ / .emacs.d / site Create it in \ _lisp'.

To put it in the PATH to emacs, add the following to init.el.

init.el

;;Set the location of el files
(setq load-path (cons "~/.emacs.d/site_lisp" load-path))

...

(require 'ox-qmd)
(add-to-list 'ox-qmd-language-keyword-alist '("ruby" . "ruby"))

How to create a local config file

If you belong to multiple Teams, or if you want to set an email address for each directory, you can specify a local configuration file.

In the directory where you want to create the configuration file

qiita config local set

And you can write in the same way as the above initial settings.

• source ~/Github/grad_research_20s/yamato/test/qiita_org_manual.org