mirror of
https://github.com/devonthesofa/obsidian-note-status.git
synced 2026-07-22 12:30:24 +00:00
docs: update marketplace submission workflow with manual steps and repository link
This commit is contained in:
parent
563d9fb202
commit
0d5cf5a0d8
4 changed files with 48 additions and 22 deletions
|
|
@ -81,8 +81,8 @@ You can contribute your own status templates to the plugin!
|
|||
|
||||
1. Create a custom template in the plugin settings.
|
||||
2. Click the **Share** (📤) icon on your custom template.
|
||||
3. It will open a GitHub page with your template content pre-filled.
|
||||
4. Click **Propose new file** and submit your Pull Request!
|
||||
3. Follow the instructions in the modal to copy the JSON and submit a Pull Request to the [official repository](https://github.com/devonthesofa/obsidian-note-status).
|
||||
4. Maintainers will review your submission and accept it if it passes the revision!
|
||||
|
||||
### How to contribute (Manual)
|
||||
|
||||
|
|
|
|||
|
|
@ -24,7 +24,6 @@ export const MarketplaceShareModal: React.FC<MarketplaceShareModalProps> = ({
|
|||
|
||||
const jsonString = JSON.stringify(marketplaceTemplate, null, 2);
|
||||
const filename = `${marketplaceTemplate.id}.json`;
|
||||
const githubUrl = `https://github.com/devonthesofa/obsidian-note-status/new/master/templates?filename=${filename}`;
|
||||
|
||||
const handleCopy = useCallback(() => {
|
||||
navigator.clipboard.writeText(jsonString);
|
||||
|
|
@ -40,23 +39,48 @@ export const MarketplaceShareModal: React.FC<MarketplaceShareModalProps> = ({
|
|||
|
||||
<div className="template-editor-modal__content">
|
||||
<p>
|
||||
To share your template with the community, follow these
|
||||
simple steps:
|
||||
Share your template with the community by following these
|
||||
steps:
|
||||
</p>
|
||||
|
||||
<ol className="marketplace-steps">
|
||||
<li>
|
||||
<strong>Copy</strong> the template data below.
|
||||
<strong>Copy</strong> the template JSON data below.
|
||||
</li>
|
||||
<li>
|
||||
<strong>Click</strong> the button to open GitHub.
|
||||
Go to the <strong>templates folder</strong> in the
|
||||
official repository:
|
||||
<br />
|
||||
<a
|
||||
href="https://github.com/devonthesofa/obsidian-note-status/tree/master/templates"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
>
|
||||
github.com/devonthesofa/obsidian-note-status/templates
|
||||
</a>
|
||||
</li>
|
||||
<li>
|
||||
<strong>Paste</strong> the content and click "Propose
|
||||
new file".
|
||||
Click <strong>Add file</strong> >{" "}
|
||||
<strong>Create new file</strong>.
|
||||
</li>
|
||||
<li>
|
||||
Name it <code>{filename}</code> and{" "}
|
||||
<strong>paste</strong> the content.
|
||||
</li>
|
||||
<li>
|
||||
Click <strong>Propose new file</strong> and submit the
|
||||
Pull Request.
|
||||
</li>
|
||||
</ol>
|
||||
|
||||
<p className="marketplace-note">
|
||||
<em>
|
||||
Note: Submissions are reviewed by maintainers. Once
|
||||
verified, your template will be included in the next
|
||||
plugin update for all users!
|
||||
</em>
|
||||
</p>
|
||||
|
||||
<div className="marketplace-json-preview">
|
||||
<div className="json-preview-header">
|
||||
<span>{filename}</span>
|
||||
|
|
@ -76,18 +100,6 @@ export const MarketplaceShareModal: React.FC<MarketplaceShareModalProps> = ({
|
|||
</div>
|
||||
|
||||
<div className="template-editor-modal__actions">
|
||||
<a
|
||||
href={githubUrl}
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className="mod-cta marketplace-github-link"
|
||||
onClick={() => {
|
||||
// Optionally close or just stay open
|
||||
}}
|
||||
>
|
||||
<ObsidianIcon name="external-link" size={16} />
|
||||
Open GitHub to Submit
|
||||
</a>
|
||||
<button onClick={onClose}>Close</button>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -282,6 +282,20 @@
|
|||
margin-bottom: var(--size-2-2);
|
||||
}
|
||||
|
||||
.marketplace-steps li a {
|
||||
color: var(--text-accent);
|
||||
word-break: break-all;
|
||||
}
|
||||
|
||||
.marketplace-note {
|
||||
margin: var(--size-4-4) 0;
|
||||
padding: var(--size-4-2);
|
||||
background: var(--background-primary-alt);
|
||||
border-left: 4px solid var(--interactive-accent);
|
||||
border-radius: var(--radius-s);
|
||||
font-size: var(--font-ui-small);
|
||||
}
|
||||
|
||||
.marketplace-json-preview {
|
||||
background: var(--background-secondary);
|
||||
border: 1px solid var(--background-modifier-border);
|
||||
|
|
|
|||
Loading…
Reference in a new issue