obsidian2web

Author

==Quickly deploy your obsidian notes to the web, and automatically update them according to git, or generate static resource files for notes==
Using mdbook and obsidian-export with GitHub's cicd and page implementation, and optimization, optimization reference
Requires a certain level of git and GitHub usage

Fork this repository
Enable github-action repository page -> Actions -> Enable
Add token permissions: Repository page -> Setting -> Action -> General -> Workflow permissions -> Click Read and write permissions
Set page: Repository page -> Setting -> Pages -> Build and deployment -> Source set to Github Actions
Put your obsidian notes under example (or copy or link)
After each change, push directly to GitHub to automatically trigger the deployment process of the GitHub page

Add this repository as a submodule
Pull submodule along with repository in CI/CD
Similar steps as above, but you need to write your own CI/CD file, CI/CD file reference

This is only applicable to linux (because the author is using a linux system)

Clone this repository
Run init.sh to download mdbook and obsidian-export. This step defaults to downloading the linux version. If you need another system version, please download it yourself
Run create.sh <path to your repository>, at this point the generated book folder is the required static file, you can deploy it on your own server

Current implementation of commonly used methods for displaying obsidian notes on the web

Method	Repository Structure Support	Export Speed	Automation Level	Automated Deployment	Feature Completeness Support	Domestic Access	Free
obsidian webpage plugin	Supported	Slow, must be done in obsidian, obsidian must be open	Requires manual clicking and waiting for export, obsidian must be open	Only supports webpage generation, cannot be directly deployed automatically	Almost complete support for all obsidian features	Slow loading due to slow css resources	Free
obsius plugin	Not supported, only single document	Fast, but unstable, depends on network and server	Right-click on a note	Deploy directly to someone else's server, not necessarily stable	Basic support for obsidian features	Unstable, as it is a foreign website	Free, but unstable
obsidian2web	Supported	Fast, exported directly from md	Combined with git, can be seamlessly updated and deployed with git plugin	Multiple methods, can choose github page deployment, or generate static webpage for self-deployment	Basic support for obsidian features	All css and js files are built-in, fast loading	Free
obsidian-digital-garden	Supports, no directory tree	Fast, because it is a single-page release	Early registration and other troublesome operations are required for single-page release	Similar to the obsius plugin	Supports basic obsidian features	Slow loading speed due to referencing some slow css resources	Free
Official release service	Support	Fast	High	High	Supports all features	Normal, loading speed is acceptable	$8 per month

The book's configuration information is in the repository's book.toml, meaning refer to mdbook