Skip to content

Commit 174620f

Browse files
committed
feat(README): Docs updated.
1 parent 7bf4513 commit 174620f

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,53 @@
11
# Invio
22

33
Invio 将你的 Obsidian 文档自动发布到 腾讯云对象存储COS 上,如果对你有用,请点个Star [star ![GitHub Repo stars](https://img.shields.io/github/stars/frontend-engineering/Invio)](https://github.com/frontend-engineering/Invio)
4+
5+
6+
[![BuildCI](https://github.com/frontend-engineering/Invio/actions/workflows/auto-build.yml/badge.svg)](https://github.com/frontend-engineering/Invio/actions/workflows/auto-build.yml)
7+
8+
[![downloads of latest version](https://img.shields.io/github/downloads-pre/frontend-engineering/Invio/latest/total?style=social)](https://github.com/frontend-engineering/Invio/releases)
9+
10+
11+
## Features
12+
13+
- Publish your docs to html webpage auto, while keeping all your styles. Inspired by [Webpage HTML Export](https://github.com/KosmosisDire/obsidian-webpage-export)
14+
- COS supports: Amazon S3 or COS compatable like tencent Cloud
15+
- **Scheduled auto sync supported.** You can also manually trigger the sync using sidebar ribbon
16+
- Auto sync your local docs's edit with remote published html. **[Sync Algorithm open](https://github.com/remotely-save/remotely-save/blob/master/docs/sync_algorithm_v2.md) is inspired by this [project](https://github.com/remotely-save/remotely-save).**
17+
- **Fully open source under [Apache-2.0 License](./LICENSE).**
18+
19+
20+
## Limitations
21+
22+
- **No content-diff-and-patch algorithm.** All files and folders are compared using their local and remote "last modified time" and those with later "last modified time" wins. For example: if one file's been edited lately, it will be fully re-uploaded.
23+
24+
- **Cloud services cost you money.** Although COS services are easier to maintain and use, however it's important to always stay mindful of the expenses and pricing associated with different operations. This includes, but is not limited to, downloading, uploading, listing files, making API calls, and storage sizes. These actions may or may not incur charges, so it's crucial to take them into consideration.
25+
- Your Obsidian desktop version should >= 0.13.25
26+
27+
28+
## Questions, Suggestions, Or Bugs
29+
30+
You are greatly welcome to ask questions, post any suggestions, or report any bugs! The project is mainly maintained on GitHub:
31+
32+
- Questions: [GitHub repo Discussions](https://github.com/frontend-engineering/Invio/discussions)
33+
- Suggestions: also in [GitHub repo Discussions](https://github.com/frontend-engineering/Invio/discussions)
34+
- Bugs: [GitHub repo Issues](https://github.com/frontend-engineering/Invio/issues) (NOT Discussion)
35+
36+
37+
## Download and Install
38+
39+
40+
- Option #1: [![GitHub release (latest by SemVer and asset including pre-releases)](https://img.shields.io/github/downloads-pre/frontend-engineering/Invio/latest/total?style=social)](https://github.com/frontend-engineering/Invio/releases) Manually download assets (`main.js`, `manifest.json`, `styles.css`) from the latest release.
41+
- Option #2: [![BuildCI](https://github.com/frontend-engineering/Invio/actions/workflows/auto-build.yml/badge.svg)](https://github.com/frontend-engineering/Invio/actions/workflows/auto-build.yml) Every artifacts are placed in the "Summary" under every successful builds. It's automatically generated by every commit, may break something.
42+
43+
## Usage
44+
45+
46+
- Prepare your COS (-compatible) service information: [endpoint, region](https://docs.aws.amazon.com/general/latest/gr/s3.html), [access key id, secret access key](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html), bucket name. The bucket should be empty and solely for publishing webpages.
47+
48+
- Download and enable this plugin.
49+
- Enter your information to the settings of this plugin.
50+
- Choose the directory you want to publish in settings. Once it's been done, you'll find the directory you chose decorated with a green icon in the left file tree list.
51+
- Click the new icon on the ribbon (the left sidebar), **every time** you want to publish your docs to remote. (Or, you could configure auto sync in the settings panel) While publishing, the icon becomes "two half-circle arrows".
52+
- **Be patient while publishing.** Especially in the first-time publish.
53+
- You can even share all your config above with your teammates. You can find **Export/Import** in the settings. So your teammates don't have to input such complicated keys or secret strings.

0 commit comments

Comments
 (0)