obsidian-plugin/encima_obsidian-writeas-plugin
1
0
Fork 0
mirror of https://github.com/encima/obsidian-writeas-plugin.git synced 2026-07-22 08:20:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated README to include documentation on configuring and using a self-hosted WriteFreely instance

Browse source
This commit is contained in:
Dave Sullivan 2024-07-28 11:59:32 -04:00
parent e49d20ec8d
commit 2f18cad78a
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -2,18 +2,22 @@
## What?
Publish notes to https://write.as.
Publish notes to https://write.as or a self-hosted [WriteFreely](https://writefreely.org/) instance.
## Disclosure
1. This plugin publishes content using the Internet
2. This plugin requires an account with https://write.as
2. This plugin requires an account with https://write.as or a self-hosted
[WriteFreely](https://writefreely.org/)
## How?
1. Set your username and password in the plugin settings
1. Set your username, password, and optionally your WriteFreely instance URL
in the plugin settings
2. Add `writeas_collection` into your frontmatter, set it to a collection/blog
that you own (this **must** be set)
- If you're using a self-hosted WriteFreely instance in single-user mode,
the `writeas_collection` value must be equal to your username
3. Run `Publish/update` (or use alt+shift+p)
4. The plugin will add the ID and the post URL to your frontmatter. Subsequent
publish commands will then update the same post.