This page is a demo page for [volglass](https://github.com/tu

README

/opt/buildhome/repo/volglass/posts/docs/learn/Converting your contents.md

CurrentProbrems

action_logs.png

create_new_repository.png

install_obsidian_git.png

obsidian_git_settings.png

open_folder_as_vault.png

pages_settings_actions.png

re-run_all-jobs.png

save_custom_domain.png

assets

Converting your contents

FileSystem-LiveSync+Cloudflare Pages

Getting Started

Obsidian Git+GitHub Pages

learn

docs

はじめに

チュートリアル

現状の問題

volglass is a tool that converts documents within Obsidian into a format that can be published on the web.
This tool does not handle the management of the repository for publishing or the pipeline leading up to deployment. You can incorporate volglass into your ideal system as you envision it.

Here, there are some example of deployment using volglass. If you have an idea not descrived here, please open issue in [volglass-docs](https://github.com/turtton/volglass-docs/issues).

- [[docs/learn/Obsidian Git+GitHub Pages|Obsidian Git+GitHub Pages]]
- [[docs/learn/FileSystem-LiveSync+Cloudflare Pages|FileSystem-LiveSync+Cloudflare Pages]]

If you want to use volglass as is, see [[Converting your contents]]. This page describes how to use volglass and volglass-cli and what these tools do.

This page is a demo page for [volglass](https://github.com/turtton/volglass).

[[volglass/docs/learn/Getting Started|Click here]] to learn how to use this.

Current issue that the way to publish documents in obsidian.

1. Sync between obsdian files and GitHub Repository

2. Conversion and parsing of Markdown files (handled by volglass).

There are various methods available for steps 1 and 3, which I believed were beyond the scope of volglass support. However, I realized that it is necessary to provide examples so that users know how to proceed.

I wanted to achieve real-time synchronization across multiple devices, so I'm using [Self-hosted livesync](https://github.com/vrtmrz/obsidian-livesync) and its associated filesync software. However, I know that this method is quite complex and not user-friendly for general users. 

I don't know of other synchronization methods, so I need to research and would appreciate it if you could let me know if you have any suggestions.  

[denolehov/obsidian-git](https://github.com/denolehov/obsidian-git) might be helpful. I'll look into its behavior later. 

As a straightforward method, one can manage the Obsidian folder directly with Git, manually committing and pushing changes. However, I prefer to consider this as a last resort.

The simplest method would be to use GitHub Pages. However, it requires setting up a deployment workflow. Although GitHub Actions can be somewhat complex, I believe this issue can be resolved by providing a template repository.

I personally use Cloudflare Pages, and there are several reasons for this choice:

- It does not require complex workflows; you can select the target GitHub repository (including private ones) and enter three items to publish the documentation.

- It allows previewing web pages at the branch or commit level. I think that is better than GitHub Pages in terms of functionality.

- It offers access restrictions, such as email authentication, for web pages (Cloudflare Access).

- All these features are available for free.

Based on these factors, there is no reason not to use Cloudflare Pages. However, I understand that some people may have reservations about using a new service.

Vercel might also be a viable option, but I am not familiar with the service, so I need to research it. In particular, I need to confirm if Java is available in the build environment.

[Github](https://github.com/turtton/volglass)

volglass is a fork project of [MindStone](https://github.com/TuanManhCao/digital-garden), a project that aims to be an alternative to ObsidianPublish.

Be sure to follow these steps because volglass-cli requires an npm project (`package.json`).

Now, volglass-cli installs `pnpm` and creates `posts` directory.

The `posts` directory is used to store the content in the obsidian vault. It is recommended that you create a README.md in the posts directory (this will be your first page in website).

The next step can be chosen from the following two options, depending on your objectives.

Volglass-cli downloads the latest volglass project and serve content automatically.

Open this link in your browser http://localhost:3000/ 

This task outputs content to `_volglass` directory.

> If you want to build as node.js server, add `-n` flag in command.

Although not recommended, you can also build with Docker in this case.

- `git clone https://github.com/turtton/volglass.git`(or `git@github.com:turtton/volglass.git`)

Place markdown files in the `posts` directory.

next.js outputs content in `out` directory.

Thanks to [ilkersigirci](https://github.com/turtton/volglass/pull/2) you can build docker image.

- `docker build -t local/volglass:latest . && docker run -d -p 3000:3000 --name volglass local/volglass:latest`

[GitHub - turtton/volglass-docs](https://github.com/turtton/volglass-docs)

Document and demo pages built in [volglass](https://github.com/turtton/volglass).

This page describes how volglass-docs is managed and published.

- ✅ Real-time synchronization across multiple devices

- ✅ Can be managed in a private repository

- ❌ Requires a server to run FileSystem-LiveSync

	cf{{CloudflarePages volglass.turtton.net}}

Getting Started

Link to this note