|
1 | | -# Phanford Obsidian Publish |
| 1 | +## Obsidian Publish |
2 | 2 |
|
3 | | -> [!NOTE] |
4 | | -> This is one of the plugins of the collections of plugins called [Nólëbase Integrations](https://github.com/nolebase/integrations). You can explore the other plugins in the collection in [the official documentation site of Nólëbase Integrations](https://nolebase-integrations.ayaka.io). |
5 | 3 |
|
6 | | ---- |
| 4 | +The purpose of this plugin is to give myself a means of publishing content from my Obsidian notebook to phanford.dev via a Git submodule. |
7 | 5 |
|
8 | | -## ⚠️ To you, the plugin developer. |
9 | | - |
10 | | -This is a template plugin for you to start developing your own Obsidian plugin. It is a good starting point for you to develop your own plugin. You can clone this repository and start developing your own plugin. |
11 | | - |
12 | | -We use the most advanced technologies to develop this plugin, including: |
13 | | - |
14 | | -- [TypeScript](https://www.typescriptlang.org/) |
15 | | -- [unbuild](https://github.com/unjs/unbuild) |
16 | | -- [eslint](https://eslint.org/) |
17 | | - |
18 | | -So everything is configured for you to start developing your own plugin, immediately. |
19 | | - |
20 | | -## ⚠️ Before publishing |
21 | | - |
22 | | -1. Replace all the `phanford-obsidian-publish` with the name of your plugin: |
23 | | - 1. In the `manifest.json` file. |
24 | | - 2. In the `package.json` file. |
25 | | - 3. In the `README.md` file. |
26 | | -2. Replace all the `Phanford Obsidian Publish` with the name of your plugin: |
27 | | - 1. In the `manifest.json` file. |
28 | | - 2. In the `package.json` file. |
29 | | - 3. In the `README.md` file. |
30 | | -3. Fill in a URL to your repository. You can replace with `https://github.com/nolebase/phanford-obsidian-publish` |
31 | | -4. Fill in the Why, Features, What can you do with it, Demos, How to install, TODOs, feel free to remove the sections that are not needed. |
32 | | -5. Replace the name `SomeViewPlugin` and `SomePlugin` with your own plugin name. |
33 | | - |
34 | | -## ⚠️ How to publish? |
35 | | - |
36 | | -1. Modify the version in the `manifest.json` file. |
37 | | -2. Modify the version in the `package.json` file. |
38 | | -3. Push the changes to the repository. |
39 | | -4. Go to the [Release] page of the repository. |
40 | | -5. Create a new release with the tag name as the version number. |
41 | | -6. Sit back and relax, the plugin will be published with CI/CD pipelines automatically. |
42 | | - |
43 | | -## 🤔 Why |
44 | | - |
45 | | -Introduce your plugin! Explain why you made it, why would users choose yours! |
46 | | - |
47 | | -## 🎨 Features |
48 | | - |
49 | | -- 📦 Out of the box support. |
50 | | -- 🚀 Blazingly fast. |
51 | | -- 💡 You define it. |
52 | | - |
53 | | -## 💡 What can you do with it |
54 | | - |
55 | | -- Help users to imagine what they can do, show your imagination. |
56 | | - |
57 | | -## 📺 Demos |
58 | | - |
59 | | -> Show me what you can do |
60 | | -
|
61 | | -### How it looks like |
62 | | - |
63 | | -Perhaps a GIF? |
64 | | - |
65 | | -## 😎 How to install |
66 | | - |
67 | | -> [!WARNING] |
68 | | -> Currently Phanford Obsidian Publish is in alpha stage, it wasn't guaranteed to work properly and keep the compatibility with the future versions of itself. |
69 | | -> |
70 | | -> But it is encouraged to try it out and give feedbacks. If you find and bugs or have any suggestions, please feel free to open an issue on [GitHub](https://github.com/nolebase/phanford-obsidian-publish/issues). |
71 | | -
|
72 | | -Currently, it is a bit hard to install the plugin for now before it is published to the official Obsidian plugin store. Manual downloading and installation is required. |
73 | | - |
74 | | -### Install with beta testing helper [BRAT](https://tfthacker.com/brat-quick-guide) plugin |
75 | | - |
76 | | -1. Install the [BRAT](https://tfthacker.com/brat-quick-guide) plugin right from the official Obsidian plugin store. |
77 | | -2. Enable the BRAT plugin in the community plugins settings menu. |
78 | | -3. Open Command palette to choose `BRAT: Plugins: Add a beta plugin for testing`. |
79 | | -4. Copy and paste the following link to the first field of the new prompted dialog: |
80 | | - |
81 | | -```txt |
82 | | -https://github.com/nolebase/phanford-obsidian-publish |
83 | | -``` |
84 | | - |
85 | | -5. Find the needed released version on [Release page of Obsidian UnoCSS Plugin](https://github.com/nolebase/phanford-obsidian-publish/releases), for example, fill in `0.1.0`. |
86 | | -6. Enable the "Phanford Obsidian Publish" plugin from the `Installed plugins` list. |
87 | | - |
88 | | -### Install manually |
89 | | - |
90 | | -1. Navigate to the [Release page of Phanford Obsidian Publish](https://github.com/nolebase/phanford-obsidian-publish/releases) |
91 | | -2. Find the [latest version of the plugin](https://github.com/nolebase/phanford-obsidian-publish/releases/latest). |
92 | | -3. Download the `main.js` file and `manifest.json` file. |
93 | | -4. Open up the `.obsidian/plugins` directory of your Obsidian vault. |
94 | | -5. If no `.obsidian/plugins` directory exists, create one. |
95 | | -6. Create a new directory named `phanford-obsidian-publish` inside the `.obsidian/plugins` directory. |
96 | | -7. Move `main.js` file and `manifest.json` file into the `phanford-obsidian-publish` directory. |
97 | | - |
98 | | -The directory structure should look like this after these steps: |
99 | | - |
100 | | -```shell |
101 | | -❯ tree |
102 | | -. |
103 | | -├── main.js |
104 | | -├── manifest.json |
105 | | -``` |
106 | | - |
107 | | -8. Enable the "Phanford Obsidian Publish" plugin from the "Installed plugins" list. |
108 | | - |
109 | | -## ⏳ TODOs |
110 | | - |
111 | | -- [ ] Anything on the roadmap? |
112 | | - |
113 | | -## 💻 How to develop |
114 | | - |
115 | | -1. As [Build a plugin - Developer Documentation](https://docs.obsidian.md/Plugins/Getting+started/Build+a+plugin) has suggested, create a separate vault for development. |
116 | | -2. (Optional) Install the hot-reload plugin: [pjeby/hot-reload](https://github.com/pjeby/hot-reload). |
117 | | -3. Create a `.obsidian/plugins` directory in the vault root. |
118 | | -4. Clone this repository into the `.obsidian/plugins` directory. |
119 | | -5. Install dependencies |
120 | | - |
121 | | -```shell |
122 | | -pnpm install |
123 | | -``` |
124 | | - |
125 | | -If you use [`@antfu/ni`](https://github.com/antfu/ni), you can also use the following command: |
126 | | - |
127 | | -```shell |
128 | | -ni |
129 | | -``` |
130 | | - |
131 | | -6. Build the plugin for development |
132 | | - |
133 | | -```shell |
134 | | -pnpm run build:dev |
135 | | -``` |
136 | | - |
137 | | -If you use [`@antfu/ni`](https://github.com/antfu/ni), you can also use the following command: |
138 | | - |
139 | | -```shell |
140 | | -nr build |
141 | | -``` |
142 | | - |
143 | | -7. Reload Obsidian to see the changes. (If you use the hot-reload plugin, you don't need to reload Obsidian manually.) |
144 | | - |
145 | | -> Reloading can be called from the command palette with `Reload app without saving` command. |
146 | | -
|
147 | | -## 🔨 How to build |
148 | | - |
149 | | -```shell |
150 | | -pnpm run build |
151 | | -``` |
152 | | - |
153 | | -If you use [`@antfu/ni`](https://github.com/antfu/ni), you can also use the following command: |
154 | | - |
155 | | -```shell |
156 | | -nr build |
157 | | -``` |
158 | | - |
159 | | -### Written with ♥ |
| 6 | +All content is maintained as markdown so Obsidian acts as editor with deliberate pushes to the submodule triggering a build of phanford.dev after initializing content |
| 7 | +submodule. |
0 commit comments