inhji
/
obsidian-micropub
1
0
Fork 0
Code Issues 4 Pull Requests 6 Packages Projects Releases 1 Wiki Activity

update README

This commit is contained in:
Inhji 2023-06-11 18:16:41 +02:00
parent 0ce4e3fede
commit d99fe80d22
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,6 +1,6 @@
# Micropub
Micropub is a community maintained plugin for [Obsidian](https://obsidian.md/) to publish notes to a Indieweb-enabled blog with support for [Micropub](https://indieweb.org/Micropub).
Micropub is a community maintained plugin for [Obsidian](https://obsidian.md/) to publish notes your own site with [Micropub](https://indieweb.org/Micropub).
## Credits
@ -20,6 +20,17 @@ This plugin is considered alpha software. Even though the publish workflow lets
- **Proper [RelMeAuth Flow](https://indieweb.org/RelMeAuth)**, for now you need to generate a static token that is validated by the Micropub endpoint and save that token in the settings of the plugin.
- **Updating posts**, once you have published at note, it is not possible to publish it again, making use of the [Micropub update action](https://www.w3.org/TR/micropub/#h-update).
- **Writing back tags, publish date, etc. to the frontmatter**, as this requires a `q=source` call to the micropub endpoint which is missing at the moment.
- **More configuration options**, for setting the names of targeted frontmatter fields, or for toggling on and of optional features like fetching tags, etc.
## Micropub Details
This plugin makes use of a few micropub features, including a few non-standard extensions
- `mp-destination` for potentially selecting a publishing destination. (https://indieweb.org/Micropub-extensions#Destination)
- `q=category` for receiving a list of existing tags/categories from the server (https://indieweb.org/Micropub-extensions#Query_for_Category/Tag_List)
- `q=config` for receiving a list of publishing channels on a site (https://github.com/indieweb/micropub-extensions/issues/40)
- `q=source` for checking for existing posts before attempting to update them (https://www.w3.org/TR/micropub/#configuration)
## Installing
@ -33,13 +44,13 @@ From the preferences window it is possible to log in using Micropub.
![](images/01-preferences.png)
Once logged in, the plugin allows to set default values for tags, post visibility, and default blog (in case the user has more than one hosted blog). These default values will be used when posting to Micro.blog.
Once logged in, the plugin allows to set default values for tags, post visibility, and default blog (in case the user has more than one hosted blog). These default values will be used when posting to your site.
![](images/02-preferences.png)
### Command
Micro.publish is triggered using Obsidian's command palette.
Micropub is triggered using Obsidian's command palette.
![](images/03-command.png)