Obsidian 插件:【Readme】Fountain Editor

Obsidian 插件:【Readme】Fountain Editor

插件名片

  • 插件名称:Fountain Editor
  • 插件作者:Chuang Caleb
  • 插件说明:在编辑器中进行剧本(Fountain)语法的语法高亮显示。
  • 插件分类:[‘obsidian 插件 ’, ‘readme’]
  • 项目地址:点我访问
  • 国内下载地址:下载安装

概述

在编辑器中进行剧本(Fountain)语法的语法高亮显示。

原文出处

下面自述文件的来源于 Readme


Readme(翻译)

下面是 fountain-editor 插件的自述翻译

Fountain 编辑器 - Obsidian 插件

Obsidian 插件,用于在编辑器中对 Fountain(剧本)语法进行语法高亮。

Fountain 编辑器 - Obsidian 插件--Readme(翻译)


常见问题解答

  • 什么是 Obsidian?
  • 什么是 Markdown?
  • 什么是 Fountain?
  • 为什么要使用这个插件? —>

🔨 使用方法

🏁 快速入门

  1. 📥 点击此处在 Obsidian 中打开安装页面
    1. 通用安装说明 链接 →
    2. 手动安装 链接 →
  2. 📄 创建一个新文件,并在元数据属性的前置元数据中添加 cssclasses: fountain
  3. 🎨 您将根据 Fountain 语法规则 获得自动语法高亮/样式化
---
cssclasses:
  - fountain
---
# 开场钩子

> 臭臭链接 <

淡出:

外景:公共洗手间 - 白天

一名警察走进一个肮脏的洗手间。她皱了皱眉。

警察(旁白)
*闻到*了一只老鼠...

= 使用 Fountain 的概要转到[[常规的markdown]]! #太酷了

💿 手动安装

  1. 🆕 您可以使用此存储库的链接(https://github.com/chuangcaleb/obsidian-fountain-editor)直接在 BRAT 上安装。
  2. 📤 您还可以转到存储库的 最新发布 页面,手动下载 obsidian-fountain-editor-[version].zip 文件,然后将其解压到您的 .obsidian/plugin 目录中!

📢 通知

  1. 🎉 我们已经超过了功能性 MVP v1.0.0!您可以开始专业而安全地使用此插件。只需记住,仍有待优化和未完成的功能。
  2. 🛟 也就是说,此插件只应扩展您的视图,绝不应修改任何本地文件!最坏的情况是,如果出现问题,只需强制重新启动 Obsidian 或手动从 community-plugins.json 列表中删除此插件。

🎯 目标

📍

使 Obsidian 成为 Fountain 写作编辑器中的一个有竞争力的选择。

🔗主要卖点是能够通过允许使用 Markdown 链接/标签/扩展语法,直接将辅助笔记与剧本连接/链接/注释到引用位置。
🤞第二个卖点是将 Fountain 剧本写作流程与 Obsidian 的整个生态系统集成在一起,这有助于探索思想知识管理(而且,嘘,它是免费的)。
🧩同样地,某些Obsidian 插件可以为您的 Fountain 剧本写作流程添加一些非常重要的功能。我最困扰的主要缺失拼图是 Fountain要求将所有内容放在一个文件中——当您有 120 多页时,这可能会变得乏味。有一个 Obsidian插件解决方案,以及 可能有其他问题的解决方案
🔎竞争并不意味着缺乏合作!正如我们在 范围设计原则 中解释的那样,如果可能的话,该插件将尽量避免重复工作,并尝试将功能外包/移交给其他 协同工具

✨ 特性

  • 🎨 在编辑视图中(源代码模式或实时预览)中获得 Fountain 语法高亮
  • ✅ 使用 cssclasses: fountain 在 frontmatter 中指定哪些个别笔记使用 Fountain 样式(选择加入的基础上,可能会有变化)
  • 🛁 尽可能地享受扩展的 Obsidian 语法- 使用您常规的 Obsidian markdown、工具、插件和工作流程!
    • 🧰 利用 Obsidian!Markdown:使用链接、标签、嵌入式笔记/图片/音频、图表…
    • 🛏️ 感觉像家一样:Fountain 的 SectionEmphasis 语法不会添加新的样式 - 这意味着它们看起来像熟悉的 Obsidian Headingsinline text styles
    • 🪓 使用 Fountain 的 Synopsis 标记退出到常规的 Obsidian!Markdown 语法高亮!
  • 🤝 与您喜爱的 Obsidian 社区插件(如 Longform结合使用
  • 🔧 使用格式为 --fountain--* 的 CSS 变量微调样式,请参阅 base.css 中的公开 CSS 变量!

📖 请参阅 设计指南 以了解我们的实现!

🤝 协同工具

📖 详细了解 协同工具,以了解它们如何与此插件一起使用!

💝 贡献

👀 概览

😎 不知道如何编码?你也可以做出贡献

  • 🪲 在 问题标签页报告错误
  • 📣 在 _ 论坛 _ 和 _ 频道 _ 以及与 _ 朋友 _ 分享**(链接至)此插件**!
    • 🌟 点赞此存储库以接收更新并提高知名度 - 如果这个项目对你来说值得点击一个按钮!
  • 🗣️ 在 讨论 标签页与他人互动
  • ✍🏼 使用此插件创建一个剧本项目
    • 📸 展示你的作品,展示你如何充分利用 Fountain + Obsidian 的优势。然后我可以在推广中重复使用你的示例,也许还能获得新功能的灵感!呵呵

🤓 会编程吗?你也可以做出贡献

  • 🔀 发起一个拉取请求! 首先关注关键的错误和优先功能。
  • 🪲 报告一个错误 — 但请附上你的 专业技术诊断
  • 🫱 给些建议! 不仅是第一次开发 Obsidian 插件,也是我第一个公共社区项目。

💝 请查看 贡献指南 以获取正确的技术细节!

🤙 联系方式

General - Discussions 标签是一个很好的地方,你可以直接在里面标记我,因为你也可以邀请社区中的任何人加入对话!这样也更好地将上下文限定在这个项目/仓库内。

如果你想要更私人的直接消息(或者只是发送一封私人感谢的便条!),你可以在 Discord 上联系我 #chuangcaleb!你也可以通过电子邮件联系我 dev@chuangcaleb.com

🔃 相关项目

  • Darakah/obsidian-fountain: Obsidian 插件,用于编辑、编写和渲染剧本和脚本的 Fountain 写作语法
    • 与此插件一样,格式化 Fountain 语法
    • 但仅适用于预览模式,并且必须包含在代码块中
    • 项目已有 2.5 年以上历史
  • chuangcaleb/ffluent: 用于打包 Fountain 剧本文件的 CLI 工具
    • 我尝试复制 longform,但针对 Fountain 文件,作为 CLI 工具。
    • 使用每个文件夹目录中的 json/yaml 文件来配置自定义序列!因此,您可以拥有复杂的文件夹组织结构
    • 该项目已被标记为废弃,但可能对您有兴趣!
  • Highland 2
    • 由 Fountain 的创作者制作。
    • 具有自己的文本编辑器应用程序、所见即所得、” 修订模式 ” 和分析工具。
    • 由于一切都包装得很好,如果您不是技术人员,这可能是最好的 Fountain 写作应用程序。


反馈交流

其他渠道

版权声明