Package: qiita-sync
Qiita-SyncQiita-Sync is a GitHub Actions that can synchronize your markdown files in GitHub repository with Qiita articles.It can be also used as a command line tool.
See more detailsQiita-Sync Command Usagefor command usage.InstallationQiita Access TokenGenerate your access tokenOpenQiita Account ApplicationsClick "Generate new token"Copy the access token displayed.Save the access token to GitHubOpen your GitHub repositoryGo "Settings" >> "Secrets"Click "New repository secrets"Save the access token with the nameQIITA_ACCESS_TOKENGitHub ActionsDownload 2 YAML files of GitHub Actionsqiita_sync.ymlqiita_sync_check.ymlSave them in your repository as:.github/workflow/qiita_sync.yml.github/workflow/qiita_sync_check.ymlNOTE: Change the cron timecron: "29 17 * * *"ofqiita_sync_check.ymlwhich is the time
when this action is sheduled to be executed.29 17 * * *indicates that this action is
executed every day at 17:29 UTC, which is kind of inactive time for me who is living in Japan.
Please adjust it to your convenience.Push them to GitHubBadgeYou can add the link to badge in your README file to show if Qiita and GitHub are successfully synchronized or not.
Please replaece<Your-ID>and<Your-Respository>of your own.![Qiita Sync](https://github.com/<Your-ID>/<Your-Repository>/actions/workflows/qiita_sync_check.yml/badge.svg)Then the badge will be displayed in your README file.synchronized badge:unsynchronized badge:SynchronizationWhen you notice the failure of synchronization by the badge in README or e-mail notification from GitHub,
you can manually run Qiita-Sync GitHub Actions to synchronize them again.Open your GitHub repositoryGo "Actions" >> "Qiita Sync" (in left pane)Click "Run workflow" (in right pane)Writing ArticlesPlease note some features of Qiita-Sync when writing articles.File NameWhen downloading Qiita article files at first, their file names are like2020-07-08_TypeScript_d3c8f2234ea428e4563a.mdwhose
naming convention is "<Created-Date>_<Tag>_<Qiita-Article-ID>.md". For your convenience,
you can rename those files as you like and can move them to any subdirectories within your git repository directory.Article HeaderEach downloaded article file has a header. This header is automatically generated when downloaded from Qiita site.
And it is automatically removed when uploaded to Qiita site.You can cangetitleandtagsas you like. Howeveryou must not removeidfrom the header.
It's a key information for synchronization with Qiita site.And thisidmust be unique. Only one file can included it in the header.
Please not to create article files that have sameid, which can happen when copying an article file.<!--
title: This header is automatically generated by Qiita-Sync when downloading Qiita articles
tags:  Qiita-Sync
id:    a5b5328c93bad615c5b2
-->When creating new article file, you don't needidin the header.<!--
title: No id is necessary in the header when writing new articles
tags:  Qiita-Sync
-->Theidwill be automatically added to the header after uploaded to Qiita site.Links to Qiita articleYou can use a relative file path as a link to another your article file.<!-- An example of link to another Qiita article when writing -->
[My Article](../my-article.md)This link will be automatically changed to the URL when uploaded to Qiita site.<!-- An example of link to another Qiita article when published to Qiita site -->
[My Article](https://qiita.com/ryokat3/items/a5b5328c93bad615c5b2)And it will be automatically changed to the relative file path when downloaded from Qiita site.Links to image fileYou can use a relative file path as a link to an image file.<!-- An example of link to image file 'earth.png' when writing-->
![My Image](../image/earth.png)This link will be automatically changed to the URL when uploaded to Qiita site.<!-- An example of link to image file 'earth.png' when published to Qiita site -->
![My Image](https://raw.githubusercontent.com/ryokat3/qiita-articles/main/image/earth.png)And it will be automatically changed to the relative file path when downloaded from Qiita site.Revision HistoryVersionDateSummaryv1.4.42021-02-21- Fixed the issue #61, enchanced code block splitterv1.4.02021-01-21- Understandable file naming when initially downloadedv1.3.42021-01-18- Internal data enhancement, verbose optionsv1.3.32021-01-16- Fixed version numberv1.3.22021-01-15- Fixed packaging failurev1.3.12021-01-15- Fixed many issues when used as CLIv1.3.02021-01-15- Withdrawn from PyPIv1.2.02021-01-11- Fixed getting Git timestamp and branch namev1.1.12021-01-11- Withdrawn from PyPIv1.1.02021-01-10- Initial release