Skip to content

Commit ff0088b

Browse files
committed
Update README
1 parent ec32112 commit ff0088b

9 files changed

Lines changed: 71 additions & 129 deletions

File tree

Installer/ObsidianShell.aip

Lines changed: 42 additions & 44 deletions
Large diffs are not rendered by default.

ObsidianShell.ContextMenu/ObsidianShell.ContextMenu.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<WarningLevel>4</WarningLevel>
2424
</PropertyGroup>
2525
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
26-
<DebugType>pdbonly</DebugType>
26+
<DebugType>none</DebugType>
2727
<Optimize>true</Optimize>
2828
<OutputPath>..\bin\Release\</OutputPath>
2929
<DefineConstants>TRACE</DefineConstants>

ObsidianShell.GUI/MainWindow.xaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
66
xmlns:local="clr-namespace:ObsidianShell.GUI"
77
mc:Ignorable="d"
8-
Title="ObsidianShell" Height="550" Width="600">
8+
Title="ObsidianShell" Height="560" Width="600">
99
<Window.Resources>
1010
<BooleanToVisibilityConverter x:Key="BoolToVisibility" />
1111
</Window.Resources>

ObsidianShell.GUI/ObsidianShell.GUI.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
</PropertyGroup>
3232
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
3333
<PlatformTarget>AnyCPU</PlatformTarget>
34-
<DebugType>pdbonly</DebugType>
34+
<DebugType>none</DebugType>
3535
<Optimize>true</Optimize>
3636
<OutputPath>..\bin\Release\</OutputPath>
3737
<DefineConstants>TRACE</DefineConstants>

ObsidianShell/ObsidianShell.csproj

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@
55
<LangVersion>11.0</LangVersion>
66
</PropertyGroup>
77

8+
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
9+
<DebugType>none</DebugType>
10+
</PropertyGroup>
11+
12+
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
13+
<DebugType>none</DebugType>
14+
</PropertyGroup>
15+
816
<ItemGroup>
917
<PackageReference Include="Fastenshtein" Version="1.0.0.8" />
1018
<PackageReference Include="NCode.ReparsePoints" Version="1.0.2" />

README.md

Lines changed: 8 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,21 @@ Languages: [English](README.md), [简体中文](README.zh-Hans.md)
88

99
For Chinese users:
1010
配合支持拼音搜索的启动器,还可以间接实现通过拼音搜索笔记文件,比如:
11-
- [Everything](https://www.voidtools.com/) + [IbEverythingExt](https://github.com/Chaoses-Ib/IbEverythingExt)
1211
- [Listary](https://www.listarypro.com/)
12+
- [Everything](https://www.voidtools.com/) + [IbEverythingExt](https://github.com/Chaoses-Ib/IbEverythingExt)
1313

1414
- VaultRecent/Recent mode
1515
- Open standalone Markdown files in Obsidian, i.e., use Obsidian as a Markdown editor.
1616
- Enable the *global vault pattern*, which means that you can share one config with your notes at different locations.
1717

1818
- Open Markdown files in Obsidian through command line
1919

20+
![](docs/GUI.png)
2021

2122
## Installation
2223
[Releases](https://github.com/Chaoses-Ib/ObsidianShell/releases)
2324

24-
Config file location: `%LOCALAPPDATA%\Chaoses Ib\ObsidianShell\ObsidianShell.Config`
25+
Config file location: `%LOCALAPPDATA%\Chaoses Ib\ObsidianShell\Settings.json`
2526

2627
### Set as the default program for Markdown files
2728
![](images/File%20list.png)
@@ -38,63 +39,29 @@ A command line interface program for opening Markdown files in Obsidian.
3839
It supports three opening modes:
3940
- VaultFallback (default)
4041

41-
If the Markdown file you want to open is in a vault, open the vault, otherwise open the file using a custom Markdown editor.
42-
43-
Related configuration:
44-
```xml
45-
<add key="OpenMode" value="VaultFallback" />
46-
```
42+
If the Markdown file you want to open is in a vault, open the vault, otherwise open the file using the fallback Markdown editor.
4743

48-
Markdown editor:
44+
Markdown editors:
4945
- Notepad (default)
50-
```xml
51-
<add key="MarkdownFallback" value="notepad" />
52-
<add key="MarkdownFallbackArguments" value="{0}" />
53-
```
54-
5546
- [Visual Studio Code](https://code.visualstudio.com/)
56-
```xml
57-
<add key="MarkdownFallback" value="%LOCALAPPDATA%\Programs\Microsoft VS Code\Code.exe" />
58-
<add key="MarkdownFallbackArguments" value="{0}" />
59-
```
60-
(The use of `code` is not recommended since it is actually an batch file and will cause some startup delays)
47+
48+
The use of `code` is not recommended since it is actually an batch file and will cause some startup delays.
6149

6250
- [Typora](https://typora.io/) (≥ 1.1)
63-
```xml
64-
<add key="MarkdownFallback" value="C:\Program Files\Typora\Typora.exe" />
65-
<add key="MarkdownFallbackArguments" value="{0}" />
66-
```
6751
- VaultRecent
6852

6953
If the Markdown file you want to open is in a vault, open the vault, otherwise link the file's parent directory to the Recent vault and then open the file.[^standalone]
7054

71-
Related configuration:
72-
```xml
73-
<add key="OpenMode" value="VaultRecent" />
74-
<add key="RecentVault" value="C:\path\to\Recent" />
75-
<add key="RecentLimit" value="10" />
76-
```
77-
where `RecentVault` is the location of your Recent vault and `RecentLimit` is the maximum number of subdirectories in Recent.
78-
7955
- Recent
8056

8157
Whether the Markdown file you want to open is in a vault, link its parent directory to the Recent vault and then open it.
8258

83-
Related configuration:
84-
```xml
85-
<add key="OpenMode" value="Recent" />
86-
<add key="RecentVault" value="C:\path\to\Recent" />
87-
<add key="RecentLimit" value="10" />
88-
```
89-
90-
9159
Notice: The vault where the Markdown file in (and the Recent vault) must be in the vault list of Obsidian before opening the file, i.e., you must have opened that vault before, otherwise Obsidian will report an error when opening the vault.
9260

93-
9461
## ContextMenu
9562
![](images/ContextMenu.png)
9663

97-
It is used to open the corresponding directory in Obsidian, complementing the defect that the CLI cannot be associated with directories.
64+
This menu is used to open the corresponding directory in Obsidian, complementing the defect that the CLI cannot be associated with directories.
9865

9966

10067
[^standalone]: [Open and edit standalone Markdown files - Feature requests - Obsidian Forum](https://forum.obsidian.md/t/open-and-edit-standalone-markdown-files/14977)

README.zh-Hans.md

Lines changed: 8 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,21 @@
77
除了方便打开笔记外,关联文件还有助于将 Obsidian 集成进你的工作流,比如你可以使用一个启动器来快速打开笔记文件。
88

99
配合支持拼音搜索的启动器,还可以间接实现通过拼音搜索笔记文件,比如:
10-
- [Everything](https://www.voidtools.com/) + [IbEverythingExt](https://github.com/Chaoses-Ib/IbEverythingExt)
1110
- [Listary](https://www.listarypro.com/)
11+
- [Everything](https://www.voidtools.com/) + [IbEverythingExt](https://github.com/Chaoses-Ib/IbEverythingExt)
1212

1313
- VaultRecent/Recent 模式
1414
- 在 Obsidian 中打开独立 Markdown 文件,将 Obsidian 用作一个 Markdown 编辑器
1515
- 实现全局仓库模式,让不同位置的笔记可以使用同一份配置
1616

1717
- 通过命令行在 Obsidian 中打开 Markdown 文件
1818

19+
![](docs/GUI.png)
1920

2021
## 安装
2122
[Releases](https://github.com/Chaoses-Ib/ObsidianShell/releases)
2223

23-
配置文件路径:`%LOCALAPPDATA%\Chaoses Ib\ObsidianShell\ObsidianShell.Config`
24+
配置文件路径:`%LOCALAPPDATA%\Chaoses Ib\ObsidianShell\Settings.json`
2425

2526
### 设为 Markdown 文件的默认程序
2627
![](images/File%20list.png)
@@ -37,63 +38,31 @@
3738
支持三种打开模式:
3839
- VaultFallback(默认)
3940

40-
如果要打开的 Markdown 文件在某个仓库中,打开该仓库,否则就用自定义的 Markdown 编辑器打开它。
41-
42-
相关配置:
43-
```xml
44-
<add key="OpenMode" value="VaultFallback" />
45-
```
41+
如果要打开的 Markdown 文件在某个仓库中,打开该仓库,否则就用回落 Markdown 编辑器打开它。
4642

4743
Markdown 编辑器:
4844
- 记事本(默认)
49-
```xml
50-
<add key="MarkdownFallback" value="notepad" />
51-
<add key="MarkdownFallbackArguments" value="{0}" />
52-
```
53-
5445
- [Visual Studio Code](https://code.visualstudio.com/)
55-
```xml
56-
<add key="MarkdownFallback" value="%LOCALAPPDATA%\Programs\Microsoft VS Code\Code.exe" />
57-
<add key="MarkdownFallbackArguments" value="{0}" />
58-
```
59-
(不推荐用 `code`,它实际上是个批处理文件,会导致一些启动延迟)
46+
47+
不推荐用 `code`,它实际上是个批处理文件,会导致一些启动延迟。
6048

6149
- [Typora](https://typora.io/)(≥ 1.1)
62-
```xml
63-
<add key="MarkdownFallback" value="C:\Program Files\Typora\Typora.exe" />
64-
<add key="MarkdownFallbackArguments" value="{0}" />
65-
```
50+
6651
- VaultRecent
6752

6853
如果要打开的 Markdown 文件在某个仓库中,打开该仓库,否则先把它的父目录链接到 Recent 仓库再打开它。[^standalone]
6954

70-
相关配置:
71-
```xml
72-
<add key="OpenMode" value="VaultRecent" />
73-
<add key="RecentVault" value="C:\path\to\Recent" />
74-
<add key="RecentLimit" value="10" />
75-
```
76-
其中 `RecentVault` 代表 Recent 仓库的位置,`RecentLimit` 代表 Recent 子目录的最大数量。
7755
- Recent
7856

7957
不论要打开的 Markdown 文件是否在某个仓库中,都先把它的父目录链接到 Recent 仓库再打开它。
8058

81-
相关配置:
82-
```xml
83-
<add key="OpenMode" value="Recent" />
84-
<add key="RecentVault" value="C:\path\to\Recent" />
85-
<add key="RecentLimit" value="10" />
86-
```
87-
88-
8959
注意:要打开的 Markdown 文件的仓库(以及 Recent 仓库)必须位于 Obsidian 的仓库列表中,也就是说,你必须在之前打开过那个仓库,否则 Obsidian 会在打开仓库时报错。
9060

91-
9261
## ContextMenu
9362
上下文菜单:
9463
![](images/ContextMenu.png)
9564

96-
用于在 Obsidian 中打开相应目录,补足 CLI 无法关联目录的缺陷。
65+
该菜单用于在 Obsidian 中打开相应目录,补足 CLI 无法关联目录的缺陷。
9766

9867

9968
[^standalone]: [Open and edit standalone Markdown files - Feature requests - Obsidian Forum](https://forum.obsidian.md/t/open-and-edit-standalone-markdown-files/14977)

docs/GUI.png

30.7 KB
Loading

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44
- `ObsidianShell.ContextMenu/Properties/AssemblyInfo.cs`
55
- `ObsidianShell.GUI/Properties/AssemblyInfo.cs`
66
2. Build the solution
7-
3. Copy files from `bin\Release` to `Installer\bin` (without PDB and XML files)
7+
3. Copy files from `bin\Release` to `Installer\bin` (without PDB and XML files) and make a `Settings.json`
88
4. Build the installer by Advanced Installer
9-
5. Pack files in `Installer\bin` as the protable version (in a directory named `ObsidianShell`)
9+
5. Pack files in `Installer\bin` as the protable version (in a directory named `ObsidianShell`)

0 commit comments

Comments
 (0)