barkstone2_vault-to-blog/README.md

# Vault To Blog
A Community Plugin for [Obsidian.md](https://obsidian.md/) to publish your vault or directory to GitHub Pages Blog.   
> This plugin is currently in beta, so it only offers a limited set of features at the moment.

> This plugin may not work properly on Windows. I have only tested it on a Mac.

## Prerequisites
- Create a GitHub Repository   
  - You need to first create a GitHub repository that will be used for GitHub Pages.
  - The name of repository should be `<username>.github.io`. 
  - For more detailed information, please refer to point 3 in [this documentation](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site).
- Set GitHub Pages to Use GitHub Actions   
  - In the repository’s settings, go to Pages and set the Build and deployment source to GitHub Actions.   
  - For more detailed information, please refer to [GitHub Pages Docs](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow).
- Public Repository Required   
  - The repository used for GitHub Pages must be set to public.
  - Private repositories are not currently supported.
- No Custom Domain Support   
  - Custom domains are not supported at this time. 
  - Please use the default GitHub Pages URL provided by GitHub.
- Authentication
  - You need to authenticate before using this plugin.
  - For more detailed information, please refer [GitHub Authentication Documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/about-authentication-to-github#authenticating-with-the-command-line).
  - If you are using SSH, you should use SSH URL of the repository.

## Usage
1. Enable plugin in the settings menu.
2. Select the directory you want to publish as a blog from the list, then click the Save button.
   - Only the contents of the selected folder will be published; the folder itself will not be displayed on the blog.
3. Input the URL of the GitHub repository that will be used for GitHub Pages. After entering the URL, click the Save button.
4. Click the Activate button to enable the plugin.
5. Once the plugin is activated, click the icon in the status bar. Your directory will now be published as a blog!

## Features
- Obsidian-style Layout
  - Left Sidebar
    - Files explorer
    - Home tab that routes to the root page
    - Draggable sidebar resizing
    - Keyword search in the sidebar tree
    - Tag query search and tag-click integration
- Markdown View
  - Basic Markdown support
  - Table of Contents (TOC)
    - Extracts TOC data from markdown headings
    - Displays TOC header components in the page view
  - Internal Links
    - Block references are not supported
    - Heading references are not supported
    - Display names are supported
  - External Links
    - Escaped characters are not supported
    - Display names are supported
  - Callouts
  - Properties
    - Aliases are not supported
  - Embedded Images
    - Display names are supported
    - Width adjustments are supported
  - Footnotes
    - Inline footnotes are not supported
    - Links in footnotes are not supported
  - Math
    - Math blocks are supported
    - Inline math expressions are supported
- Utterances Comments Layout
  - Comments layout provided by the Utterances are supported
- SEO
  - Generates indexable output for published pages
- Homepage Configuration
  - Supports configurable `index.md` as the homepage
## Demo Page
If you want to see a demo page, you can see the very simple result [here](https://barkstone3.github.io/).

## Bug Report
To report a bug, simply go to the [Issues](https://github.com/barkstone2/vault-to-blog/issues) tab and use the provided template to submit your bug report.

## Support
If you like this plugin and would like to support its development, you can support me on Buy me a coffee.

<a href="https://www.buymeacoffee.com/barkstone2" rel="nofollow">
  <img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="width: 120px; max-width: 100%;">
</a>