mirror of
https://github.com/barkstone2/vault-to-blog.git
synced 2026-07-22 10:50:30 +00:00
docs: README.md 업데이트
- 버그 리포트 템플릿 추가
This commit is contained in:
barkstone
barkstone2
parent
9151230f2b
commit
3b971272b1
2 changed files with 133 additions and 5 deletions
58
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
Normal file
58
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
Normal file
|
|
@ -0,0 +1,58 @@
|
|||
name: Bug Report
|
||||
description: File a bug report.
|
||||
title: "[BUG] "
|
||||
labels: ["bug"]
|
||||
body:
|
||||
- type: textarea
|
||||
id: what-happened
|
||||
attributes:
|
||||
label: Describe the bug
|
||||
placeholder: Tell us what you see!
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Relevant errors (if available) from notifications or console (`CTRL+SHIFT+I`)
|
||||
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
|
||||
render: shell
|
||||
- type: textarea
|
||||
id: reproduce
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: Expected Behavior
|
||||
description: A clear and concise description of what you expected to happen.
|
||||
- type: textarea
|
||||
id: context
|
||||
attributes:
|
||||
label: Addition context
|
||||
description: Add any other context about the problem here.
|
||||
- type: dropdown
|
||||
id: os
|
||||
attributes:
|
||||
label: Operating system
|
||||
description: Which OS are you using?
|
||||
options:
|
||||
- Windows
|
||||
- Linux
|
||||
- macOS
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: obsidian-version
|
||||
attributes:
|
||||
label: Obsidian Version
|
||||
description: What version of Obsidian are you running?
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: version
|
||||
attributes:
|
||||
label: Plugin version
|
||||
validations:
|
||||
required: true
|
||||
80
README.md
80
README.md
|
|
@ -1,7 +1,77 @@
|
|||
# 프로젝트 소개
|
||||
옵시디언 볼트를 깃허브 블로그로 만들어 주는 자동화 툴입니다.
|
||||
# Obsidian 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.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
---
|
||||
|
||||
- Create a GitHub Repository
|
||||
- You need to first create a GitHub repository that will be used for GitHub Pages.
|
||||
- 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.
|
||||
|
||||
## 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 only
|
||||
- Markdown View
|
||||
- Basic Markdown support
|
||||
- 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
|
||||
## Bug Report
|
||||
|
||||
---
|
||||
|
||||
To report a bug, simply go to the [Issues](https://github.com/barkstone2/obsidian-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" target="_blank">
|
||||
<img src="https://downloads.intercomcdn.com/i/o/234105/0d29fbdf17e257cdfc2ba1ba/7103925065c5e9bd6ac7ac9efd453fd7.png" alt="buy-me-a-coffee" style="background-color: yellow; border-radius: 4px; padding: 4px; width: 120px;">
|
||||
</a>
|
||||
Loading…
Reference in a new issue