obsidian-telegraph-publish

KO | EN

gitlite — search

#javascript #python #hacktoberfest #golang #deep-learning #macos #nodejs #windows #cli #kubernetes #vue #awesome-list #security #pytorch

obsidian-telegraph-publish

(★ 47)

Publish your Obsidian note to a Telegraph page.

obsidian-telegraph-publish 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## Obsidian Telegraph Publish

Publish your Obsidian note to a Telegraph page.

Features:
- Publish the active file to a new Telegraph page (create).
- Publish the active file to an existing Telegraph page (update).
- Clear published content of the active file.

Upcoming:
- [ ] Support image uploading. (as images on telegra.ph embedding directly from external website, now use '![](https://raw.githubusercontent.com/reorx/obsidian-telegraph-publish/master/url)' to embed image)

## Installation

Currently this plugin is in review, but you can take a try by either ways below:
1. Manually download the [latest release](https://github.com/reorx/obsidian-telegraph-publish/releases) from GitHub and extract the files in `$YOUR_VAULT/.obsidian/plugins/obsidian-telegraph-publish`.
2. Use [BRAT plugin](https://github.com/TfTHacker/obsidian42-brat)

## Formatting support

Telegraph has restricted support for HTML tags, therefor it's not practical to publish very complicated pages. You can see a [showcase](https://telegra.ph/2022031122-Test-telegraph-publish-02-03-12) of which the [sample note](./sample_note.md) is rendered.

|Markdown Syntax|Support|
|---|---|
|**Inline**| |
|`**bold**`|✔|
|`*italicized*`|✔|
|`code`|✔|
|`~~strike through~~`|x|
|`==highlight==`|x|
|`[external link](/)`|✔|
|`[[internal link]]|Render as external link to `#`|
|`![[embedded image]]`|Plan to support|
|**Block**| |
|`- list`|Nested list will be flattened|
|`> blockquote`|List in blockquote will be separated|
|<code>\`\`\`code block</code>|✔|
|`<table>`|Render as code block|

## How to use

### Create a Telegraph account

Before publishing any pages, you need to create a Telegraph account first.

Open settings of **Telegraph Publish**

![](https://raw.githubusercontent.com/reorx/obsidian-telegraph-publish/master/images/settings.png)

You can see **Access token** is empty, click the**Create new account" button, the new account will be created and access token will be filled automatically.

![](https://raw.githubusercontent.com/reorx/obsidian-telegraph-publish/master/images/settings-done.png)

You can click the `auth_url` to authenticate this account in your browser, so that you can edit the published pages later.

### Publish a new page

To publish a new page, first you need to open a markdown file,
then click the sidebar button or run the command called
**"Publish to Telegraph"**.

![](https://raw.githubusercontent.com/reorx/obsidian-telegraph-publish/master/images/command-create.png)

Click **"Yes"** in the confirm modal: ![](https://raw.githubusercontent.com/reorx/obsidian-telegraph-publish/master/images/create-confirm.png)

Then wait a second, after the page has been successfully created, you will see the Telegraph page URL in the next modal:

![](https://raw.githubusercontent.com/reorx/obsidian-telegraph-publish/master/images/create-success.png)

Click the URL to open the page in your browser, if you have already authenticated through `auth_url` in settings, you will be able to see the **Edit** button on the right side of the page.

![](https://raw.githubusercontent.com/reorx/obsidian-telegraph-publish/master/images/telegraph-edit.png)

Now go back to the note, and switch to source mode, you can notice that the frontmatter is updated with two new keys: `telegraph_page_url` and `telegraph_page_path`. They are used to keep track of the connection from the note to the Telegraph page.

![](https://raw.githubusercontent.com/reorx/obsidian-telegraph-publish/master/images/frontmatter.png)

### Update an existing page

If you have already published a note, you can change its content and simply run **"Publish to Telegraph"** again to update the existing page. The modal will shown as below:

![](https://raw.githubusercontent.com/reorx/obsidian-telegraph-publish/master/images/update-confirm.png)

As long as the frontmatter is correct and the access token is unchanged, you can always update the page associated with the new.

### Clear the published content

Since Telegraph does not provide a delete page API, the plugin provides a **Clear published content on Telegraph** command to remove the content of a published page.

![](https://raw.githubusercontent.com/reorx/obsidian-telegraph-publish/master/images/command-clear.png)

After running the command you will see the following modal:

![](https://raw.githubusercontent.com/reorx/obsidian-telegraph-publish/master/images/confirm-clear.png)

Click **Yes** and wait for the clearing process to finish.

![](https://raw.githubusercontent.com/reorx/obsidian-telegraph-publish/master/images/clear-success.png)

Open the URL again, you will see the content of the page is only a `Deleted` word left.

obsidian-telegraph-publish

obsidian-telegraph-publish 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

obsidian-telegraph-publish

obsidian-telegraph-publish 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README