2023-06-30-SHARE 2023 - 06 - 30 -份额

2023-06-30-LINK 2023 - 06 - 30 -链接

About this repo 关于这个回购

This repo is used for hosting public releases of Obsidian, as well as our community plugins & themes directories.此代码库用于托管 Obsidian 的公开版本，以及我们的社区插件和主题目录。

Obsidian is not open source software and this repo DOES NOT contain the source code of Obsidian. However, if you wish to contribute to Obsidian, you can easily do so with our extensive plugin system. A plugin guide can be found here: https://docs.obsidian.mdObsidian 并非开源软件，此代码库也不包含 Obsidian 的源代码。不过，如果您希望为 Obsidian 做出贡献，可以通过我们强大的插件系统轻松实现。插件指南可在此处查阅：https://docs.obsidian.md

This repo does not accept issues, if you have questions or issues with plugins, please go to their own repo to file them. If you have questions or issues about core Obsidian itself, please post them to our community: https://obsidian.md/community此仓库不接受问题报告，如果您有关于插件的问题或遇到问题，请前往插件各自的仓库提交。如果您有关于 Obsidian 核心本身的问题或遇到问题，请在我们的社区发帖：https://obsidian.md/community

Submit your plugin or theme提交您的插件或主题

When opening a pull request, please switch to preview mode and select the option to go through our submission checklist. Submit your entry by following the convention in the JSON file and we will review your submission.在打开拉取请求时，请切换到预览模式，并选择通过我们的提交清单。按照 JSON 文件中的约定提交您的条目，我们将审核您的提交。

Thanks for submitting your creations!感谢您提交您的作品！

You can find a detailed explanation for submitting your plugin here and your theme here.您可以在提交插件的此处以及提交主题的此处找到详细说明。

Community Theme 社区的主题

To add your theme to our theme store, make a pull request to the community-css-theme.json file. Please add your theme to the end of the list.若要将您的主题添加到我们的主题商店，请向  community-css-theme.json  文件发起拉取请求。请将您的主题添加到列表末尾。

• name: a unique name for your theme. Must not collide with other themes.name ：您的主题的唯一名称。不得与其他主题冲突。
• author: the author's name for display.author ：作者的显示名称。
• repo: the GitHub repository identifier, in the form of user-name/repo-name, if your GitHub repo is located at https://github.com/user-name/repo-name.repo ：GitHub 仓库标识符，格式为  user-name/repo-name ，如果您的 GitHub 仓库位于  https://github.com/user-name/repo-name  。
• screenshot: path to the screenshot of your theme.screenshot ：您的主题截图的路径。
• modes: if your theme supports both dark and light mode, put ["dark", "light"]. Otherwise, put ["dark"] if your theme only supports dark mode, or ["light"] if your theme only supports light mode.如果您的主题支持深色和浅色模式，请输入  ["dark", "light"] 。否则，如果您的主题仅支持深色模式，请输入  ["dark"] ；如果仅支持浅色模式，请输入  ["light"] 。
• publish: if your theme supports Obsidian Publish, set this to true. Omit it otherwise.如果您的主题支持 Obsidian Publish，请将此设置为  true 。否则请省略。

To get your theme compatible with Obsidian Publish, you can now use applyCss and applyCssByLink to test out your CSS in the developer console of Obsidian Publish sites, so that you don't actually need to own sites to test your publish.css. You can test it out on our help site here: https://help.obsidian.md/要使您的主题与 Obsidian Publish 兼容，您现在可以在 Obsidian Publish 站点的开发者控制台中使用  applyCss  和  applyCssByLink  来测试您的 CSS，这样您实际上无需拥有站点即可测试您的  publish.css 。您可以在我们的帮助站点上进行测试：https://help.obsidian.md/

applyCss takes a CSS string, you can use backtick (template strings) for multiline CSS. applyCssByLink takes a link and loads the CSS, would recommend GitHub raw file URLs.applyCss  接收一个 CSS 字符串，您可以使用反引号（模板字符串）来编写多行 CSS。 applyCssByLink  接收一个链接并加载 CSS，建议使用 GitHub 的原始文件 URL。

Community Plugin 社区插件

Open source policy 开源政策

We encourage all plugin developers to open source their plugins, however, we recognize that this may not always be possible.我们鼓励所有插件开发者将其插件开源，不过我们也认识到这并非总是可行的。

Closed source plugins must be clearly indicated in the plugin description and readme with the following text:闭源插件必须在插件描述和读取说明中明确标注以下文字：

This plugin is closed source.此插件为闭源。

Advertisement policy 广告政策

Dynamic advertisements 动态广告

Dynamic advertisements (like Google Ads and others, which load ads from the internet) are not allowed for listed community plugins. We firmly believe that dynamic ads are a poor fit for the Obsidian ecosystem and the principles we follow. In addition, dynamic ads are a huge security risk for our users.动态广告（例如谷歌广告及其他从互联网加载广告的广告）不允许出现在已列出的社区插件中。我们坚信动态广告与 Obsidian 生态系统以及我们遵循的原则格格不入。此外，动态广告对我们的用户来说存在巨大的安全风险。

Static advertisements 静态广告

Plugins showing static advertisements (like banners, messages, etc) for a third party must be clearly indicated in the plugin description and readme with the following text:显示第三方静态广告（如横幅、消息等）的插件必须在插件描述和说明文件中明确标注以下内容：

This plugin is supported by advertisements.此插件由广告提供支持。

In addition, advertisements must not show up spontaneously, such as in a pop-up modal, notice, etc. They must only be delivered in the plugin's own interfaces (for example: custom views, settings tab), or be triggered by a deliberate user action (for example: clicking a button that says "learn more").此外，广告不得自行弹出，例如在弹出式模态框、通知等中出现。它们只能在插件自身的界面（例如：自定义视图、设置选项卡）中展示，或者由用户的明确操作触发（例如：点击写着“了解更多”的按钮）。

Self advertisements 自我广告

Plugins showing advertisements for the plugin itself, or for the author of the plugin (for example, asking for donations/support, advertise other plugins from the same author, etc) are allowed, but must follow the same placement and timing policy as static advertisements.插件自身展示广告或为插件作者展示广告（例如请求捐款/支持、宣传同一作者的其他插件等）是允许的，但必须遵循与静态广告相同的展示位置和展示时间政策。

Community Plugins format 社区插件格式

To add your plugin to the list, make a pull request to the community-plugins.json file. Please add your plugin to the end of the list.若要将您的插件添加到列表中，请向  community-plugins.json  文件发起拉取请求。请将您的插件添加到列表末尾。

• id: A unique ID for your plugin. Make sure this is the same one you have in your manifest.json.id ：您插件的唯一标识符。请确保这与您在  manifest.json  中填写的一致。
• name: The name of your plugin.name ：您的插件名称。
• author: The author's name.author ：作者的名字。
• description: A short description of what your plugin does.简要描述您的插件的功能。
• repo: The GitHub repository identifier, in the form of user-name/repo-name, if your GitHub repo is located at https://github.com/user-name/repo-name.GitHub 代码库标识符，格式为  user-name/repo-name ，如果您的 GitHub 代码库位于  https://github.com/user-name/repo-name  。

How community plugins are pulled社区插件是如何被引入的

• Obsidian will read the list of plugins in community-plugins.json.Obsidian 将读取  community-plugins.json  中的插件列表。
• The name, author and description fields are used for searching. name 、 author  和  description  这几个字段用于搜索。
• When the user opens the detail page of your plugin, Obsidian will pull the manifest.json and README.md from your GitHub repo).当用户打开您的插件详情页面时，Obsidian 会从您的 GitHub 代码库中获取  manifest.json  和  README.md  。
• The manifest.json in your repo will only be used to figure out the latest version. Actual files are fetched from your GitHub releases.您仓库中的  manifest.json  仅用于确定最新版本。实际文件是从您的 GitHub 发布页面获取的。
• If your manifest.json requires a version of Obsidian that's higher than the running app, your versions.json will be consulted to find the latest version of your plugin that is compatible.如果您的插件需要的 Obsidian 版本高于正在运行的应用程序版本，将查询您的插件库以查找与当前版本兼容的最新插件版本。
• When the user chooses to install your plugin, Obsidian will look for your GitHub releases tagged identically to the version inside manifest.json.当用户选择安装您的插件时，Obsidian 将查找与  manifest.json  内版本标记相同的您的 GitHub 发行版。
• Obsidian will download manifest.json, main.js, and styles.css (if available), and store them in the proper location inside the vault.黑曜石将下载  manifest.json 、 main.js  和  styles.css （如果可用），并将它们存储在保险库内的适当位置。

Announcing the First Public Release of your Plugin/Theme宣布您的插件/主题的首次公开发布

• Once admitted to the plugin/theme browser, you can announce the public availability of your plugin/theme: 一旦您的插件/主题被纳入插件/主题浏览器，您就可以宣布其已正式公开可用：
  • in the forums as a showcase, and在论坛中作为展示，以及
  • on the Discord Server in the channel #updates. (You need the developer role to be able to post in that channel; you can get that role here.)在 Discord 服务器的  #updates  频道中。（您需要  developer  角色才能在该频道发布消息；您可以在此处获取该角色。）
• You can also announce the first working version of your plugin as a public beta before "officially" submitting it to the plugin/theme browser. That way, you can acquire some beta testers for feedback. It's recommended to use the BRAT Plugin to make the installation as easy as possible for interested beta testers.您也可以在“正式”向插件/主题浏览器提交之前，将您的插件的第一个可用版本作为公开测试版发布。这样，您就可以获得一些测试人员提供反馈。建议使用 BRAT 插件，以便让感兴趣的测试人员能够尽可能轻松地进行安装。