Invio provides users with a seamless workflow for synchronizing their Obsidian documents and publishing them to AWS S3 or compatible COS.
With Invio, you can automate the conversion of your documents into HTML web pages and keep them in sync across multiple devices.
Go to check the open sourced github repo: Invio
sort
in metadata canonical
Site ConfigInvio is a tool designed to simplify the management of your documents and seamlessly integrate them between your local device and an online website.
Invio aims to streamline document management and empower users to focus on the creative aspects of their work.
With Invio, you can enjoy the process of editing and writing without worrying about server maintenance or other technical complexities.
Invio also allows for easy sharing of configuration settings with teammates for collaboration purposes.
Invio offers SEO optimization to improve search engine indexing. Additionally, it handles conflicts in edits through a merge strategy.
Option #1: Search Invio in the official "community plugin list", or visit this: https://obsidian.md/plugins?id=invio (which should redirect you into Obsidian app), then install the plugin.
Option #2: You can also use Obsidian42 - BRAT to install this plugin. Input frontend-engineering/Invio in the configuration of BRAT.
Option #3: Manually download assets (main.js
, manifest.json
, styles.css
) from the latest release.
Option #4: Every artifacts are placed in the "Summary" under every successful builds. It's automatically generated by every commit, may break something.
After simple S3 setup, all you need to do is click the Invio ribbon icon.
Streamlining Your Workflow with Invio
Clicking on the ribbon icon will trigger the sync and publish process, which will be handled by Invio. You don't need to worry about anything else - just sit back and wait for the report once everything is done.
You can check the report on the right panel of the screen. This will provide you with all the information you need about the sync and publish process, including any errors or issues that may have come up. With Invio, it's easy to stay on top of your website and make sure everything is running smoothly.
A statistic report would show on the right sidebar when publishing.
All process details would be listed here. So you can see which files are syncing and which files are publishing.
If any job failed, it would be listed here either.
The action report is not only for running jobs review. It would show an auto-fix button if files failed to publish. Click the button, it would auto redo the jobs failed. Super useful when your network is not stable.
To enable Invio and publish Obsidian documents to AWS S3 / Tencent Cloud Object Storage (COS), please follow these steps:
Prepare your COS (-compatible) service information, : endpoint, region, access key id, secret access key, bucket name:
Download and enable the Invio plugin in your Obsidian settings.
Enter your COS information into the settings of the Invio plugin:
Once the setup is complete, you will see a green icon next to the chosen directory in the left file tree list.
To publish your documents to remote, click on the new icon on the ribbon (left sidebar). Alternatively, you can configure automatic synchronization in the settings panel. During the publishing process, the icon will change to "two half-circle arrows".
If you're using Tencent Cloud(COS), and your bucket region is ap-shanghai
Your settings should be like:
- Endpoint cos.ap-shanghai.myqcloud.com
- Region ap-shanghai
- AccessKeyID YourSercretId
- SecretAccessKey YourAccessKey
- BucketName obsidian-123456789
To test your settings, you can click the button check in settings to test your COS connectivity.
Invio provides a feature that allows you to collaborate and share your configuration with teammates. By using the "Export/Import" option in the settings menu, you can easily export your configuration settings and share them with your teammates. This eliminates the need for them to input complex keys or secret strings manually.
Once your teammates have imported the shared configuration, you can all edit the documents together. Invio will sync (manual/auto) all your edits and changes, ensuring everyone has the most up-to-date version of the document.
In the case of conflicts where multiple people edit the same document simultaneously, Invio follows an ordinary merge strategy, where the latest edit takes precedence. If conflicts occur, a .conflict.md file will be automatically generated in your local folder. This file contains the remote version of the conflicted file, allowing you to manually compare and resolve the conflict.
Collaboration is made easier through Invio, enabling seamless teamwork and efficient document editing.
To configure the SEO settings for your published site, you can use the Meta config feature Metadata in Invio. This allows you to optimize your pages for search engine indexing and improve the quality of web page retrieval.
Before publishing your site, it's important to pay attention to SEO configuration for important pages. This will help search engines index and retrieve your web pages more effectively. You can refer to the SEO friendly document for guidance on how to make your pages SEO-friendly.
By optimizing your SEO settings, you can enhance the visibility and discoverability of your published site in search engine results.
The most frequently asked questions about Invio. Help
Or you can submit new issues github