Important
This plugin has been superceeded by Unitade, which allows not only opening .txt files as markdown by default, but allows you to specify any arbitrary extension to open as markdown. Check it out!
A plugin for Obsidian which allows editing of txt files as if they were markdown.
The required APIs were only added in Obsidian 0.10.12, and as such, that is the minimum version of Obsidian required to use this plugin.
From Obsidian v0.9.8, you can activate this plugin within Obsidian by doing the following:
- Open Settings > Third-party plugin
- Make sure Safe mode is off
- Click Browse community plugins
- Search for this plugin
- Click Install
- Once installed, close the community plugins window and activate the newly installed plugin
You can follow the same procedure to update the plugin
- Download the Latest Release from the Releases section of the GitHub Repository
- Extract the plugin folder from the zip to your vault's plugins folder:
<vault>/.obsidian/plugins/
Note: On some machines the.obsidianfolder may be hidden. On MacOS you should be able to pressCommand+Shift+Dotto show the folder in Finder. - Reload Obsidian
- If prompted about Safe Mode, you can disable safe mode and enable the plugin. Otherwise head to Settings, third-party plugins, make sure safe mode is off and enable the plugin from there.
Third-party plugins can access files on your computer, connect to the internet, and even install additional programs.
The source code of this plugin is available on GitHub for you to audit yourself, but installing plugins into Obsidian is currently a matter of trust.
I can assure you here that I do nothing to collect your data, send information to the internet or otherwise do anything nefarious with your system. However, be aware that I could, and you only have my word that I don't.
This project uses Typescript to provide type checking and documentation.
The repo depends on the latest plugin API in Typescript Definition format, which contains TSDoc comments describing what it does.
Note: The Obsidian API is still in early alpha and is subject to change at any time!
If you want to contribute to development and/or just customize it with your own tweaks, you can do the following:
- Clone this repo.
npm ioryarnto install dependenciesnpm run buildto compile.- Copy
manifest.json,main.jsandstyles.cssto a subfolder of your plugins folder (e.g,<vault>/.obsidian/plugins/<plugin-name>/) - Reload obsidian to see changes
Alternately, you can clone the repo directly into your plugins folder and once
dependencies are installed use npm run dev to start compilation in watch mode.
You may have to reload obsidian (ctrl+R) to see changes.
Huh? This is an open-source plugin I made for fun. It's completely free. However, if you absolutely have to send me money because you like it that much, feel free to throw some coins in my hat via the following:
Initial release!
