local-first-tistory 0.0.1

It will help you to manage locally saved markdown to upload to Tistory

Local First Tistory

Do not be afraid of shutting down blog server. It will help you organize the posts in local-first, server-last rules.

Why Use This?

If you've ever been in trouble when the blog server were shut down, (especially the one is big-tech and never expecting abnormal!) this script just for you.

You will hold all the data in the local and the script will manage all the things to communicate with the server. You can read the data when you (or the server 😂) are offline or migrate to the other platforms.

Table of Contents

• Installation
• Quick Start
• Markdown
• Image
• Miscellaneous

Installation

• Python >= 3.9

• To install package:

  pip install tistory-helper
  

Quick Start

You can use tistory-helper using $ tistory [command].

To start off, you run:

tistory init

It will handle 3 things:

• Authorization
• Create Default Directory
• Create Category Directory

Authorization

You will see prompts and please follow the instructions.

To get App ID and Secret Key:

1. Go to https://www.tistory.com/guide/api/manage/register

2. Fill out your form.

   Please be aware of CallBack column to {blog_name}.tistory.com, not http://{blog_name}.tistory.com, https://~ nor https://www.~.

   

3. Now you get App ID and Secret Key. You can check CallBack column and if it doesn't follow the {blog_name}.tistory.com, you can modify it here.

4. Enter App ID and Secret key while following the prompts.

5. All the data you input will be stored at $HOME/.tistory/.env. If anything went wrong, you can modify the data manually.

Default Directory

It will be done automatically. You can check the default directory:

tree -a ~/.tistory 

$HOME/.tistory
├── .categories.toml
├── .env
├── .metadata.toml
├── images
└── markdowns

Category Directory

It will create directories according to your categories from blog automatically.

tree -a ~/.tistory/markdowns 

$HOME/.tistory/markdowns
├── category1
├── category2
│   ├── category3
│   └── category4
└── category5

Help

$ tistory or $ tistory --help.

Markdown

Markdown Location

You put all your markdown in $HOME/.tistory/markdowns/{your_category}.

Upload Markdowns

tistory md

It will detect all the modified or create file and upload it.

Write Markdown

Put the meta data on very top of the markdown file like:

---
title or t or 제목: your_title [Mandatory]
visibility or vis or v or 공개: [Optional]
published: TIMESTAMP (default: current_time) [Optional]
tag or tags or 태그: tag1,tag2,tag3 (default: '') [Optional]
acceptComment or ac or comment or 댓글: [Optional]
---

Your Content starts from here

• visibility (default: private):
  • public: public or 3 or 공개
  • protected: protected or 1 or 보호
  • private: private or 0 or 비공개
• acceptComment (default: yes):
  • To accept: yes or y or true or t or 허용 or 1
  • To deny: no or n or false or f or 거부 or 0

You will notice that only title is mandatory and not the others. This is the example:

# markdowns/category/example.md

---
t: This is my first article!
v: public
ac: 허용
tag: my article,first issue
---

And here it is article content!

For more information, go to official API.

Image

Image Location

Put your images you want to upload in $HOME/.tistory/images/.

Upload Images

• Make sure images extension end with .png, .jpg, .jpeg or .gif.

• Run:

  tistory img
  

• Uploaded image url will be stored at $HOME/.tistory/.images.toml and you can use url when writing markdown.

• Recommend to upload images first before writing your markdowns since you need url in ![images](url).

Miscellaneous

Category

If you updated category from your blog and to upgrade it:

tistory category

Reauthorization

If something went wrong while tistory init, you can do authorization step independently:

tistory auth

Or you can modify the field at $HOME/.tistory/.env manually.