UNITADE.md
falcion33k downloadsTreat any file as any view, code editor and syntax highlighting, modals for creating and renaming files, assign views for files, unloading registries and many more for advanced work with non-markdown files.
- Overview
- Scorecard
- Updates40
.svg)
About the project
Unfortunately, Obsidian does not, for some reason, have the ability to edit any file extensions that the user would like to edit, and the plugins that exist for this application are an inconvenient format for the end user, for example, entering a full-fledged JSON in one line.
Plugin UNITADE presents a simple yet advanced and user-friendly solution of this file extension problem: you can not only open and registry any extension in OBSIDIAN, but also, force-open them in your vault, render them as code just like in other code editing software (like Visual Studio Code for example) and many other infrastructure and functionalities, including compatibility modules for stale versions of plugin.
[!Note] This project has custom brandbook (guidelines) and license for it's media (logo and etc.).
Please, read this file if you interested in UNITADE's media.
Built-with
Project is created and “written” with help of:
Getting started
Before asking questions, read this block because here is all the primary information on the project, which can answer your future not-yet asked questions.
Prerequisites
Before downloading the source code or using this project ensure you met the following requirements:
- Installed Node.js on your desktop on which you will edit/setup this project;
- Installed Obsidian, app, for which this plugin is created and on which you'll test/use this plugin;
Installation
Permission is granted for free use in any of your products.
If you want to use this plugin, there are two ways to download-and-use this plugin: official and direct, so, let's start from official path:
- Go to your vault's settings, and go to "Settings → Community plugins" and go to the second step;
- Disable restricted mode, and use "Community plugins → Browse" to find this plugin: type the name of the project or just write “any as note”;
- Use plugin, type any extension in plugin's settings, edit anything you want.
Guidelines for direct-installation way:
- Download last tag on project's repository, for the last ZIP-tarball link provided below:
download latest release; - Open your vault's folder, go to the subfolder "`/.obsidian/ → /plugins/" and paste contents of downloaded ZIP into this subfolder;
- Now, you can use plugin just as if you installed it from community plugins.
Guidelines for installation of source code of this project:
- Clone the repository with any form of app which supports Git (or CLI of GitHub), guide is attached:
https://www.howtogeek.com/451360/how-to-clone-a-github-repository/ - Open it with any suitable for you editor and feel free to customize, update and/or contribute to this project[^1].
Usage
Usage of UNITADE plugin is very easy and comfortable for common user, by default, you can edit any plain text (.TXT) files in your vault, but if you want to add custom extensions, you can easy do it with plugin's settings, there is an instruction:
- Go to your vault's settings and seek for "community plugins" sector, if you have restricted mode, repeat first and second steps of official installation guide[^2];
- If you have installed plugin and app saw it, you can see element named "UNITADE": open it and seek for setting named “extensions” and type an array of extensions, separated by "greater-than sign" (
>);- This method applies only if you want to read files as .MD extensions, for more information about settings, modes and other things in the plugin, read the wikipedia of plugin: https://github.com/Falcion/UNITADE.md/wiki
- Now, you can edit extensions which you typed in settings.
Roadmap
- Create basic repository infrastructure for this project, including:
- basic .MD documentations and dealings stuff (like README, LICENSE and etc.);
- scripts and actions within CI/CD for supporting high-quality of this project;
- Write and publish the demo (pre-release) version of project, including the most basic logic of this one.
- Write the documentation for this demo-project and:
- make it one as archive for technical docs purposes (hyperlinking directive);
- Refactor and prepare for “advancing” the project's logic and write an entire functionality of it.
- Write an advanced .TS script for managing core of this project's functionality (being a template);
- Write an advanced infrastructure for project's surroundings and etc.;
- Refactor and prepare for “advancing” the project's documentation and publish it via the archive.
Contributing
Contributions are what make open source community such an interest place to be in, so any form of contribution are greatly appreciated.
If you think that you can help this project become better but think its not so important/realizable in the current situtation or for a full contribution, use issues page, otherwise there is a guideline and policy for contributing.
If you want to contribute to this project, please, read contributioning policy and commit convention, this repository works with CLA, commits convention and on automated deployment system[^4].
For one-single file contributioning, use a more quicker way without forking the repository through website.
More about it in this article:
- “Working with forks” about syncing one-file fork;
License
Project thanks the Electron.js and Angular.js for their amazing repository scripts and entire infrastructure, which partially were imported to this repository.
For individual licensing and credits information, seek correspondive files and/or sources.
Project itself is being distributed under the MIT License — see the file for more specified information.
Entirery of project's infrastructure is taken from repository template project:
https://github.com/Falcion/Patternugit.git
Media of this project is licensed under the CC-BY-SA-4.0 license and has custom guidelines in terms of brandbook, read this file before using any media affiliated with project.
Contact
For any legal purposes, you can contact developer/maintainer through its e-mail:
- Outlook E-mail
You can also check contact information in CODEOWNERS file within referencing our contacts.
If the developer/maintainer didn't answered, or you have other questions in nature, you can use issues page on this repository via specified templates or indirect self-written issue.
Acknowledgments
[^1]: for contributing policy, see — CONTRIBUTING.md [^2]: .../#installation