mirror of
https://github.com/aths7/cypher.git
synced 2026-07-22 11:20:27 +00:00
updating readme
This commit is contained in:
aths7
parent
9fb7a0dfc0
commit
bcde65d7a3
1 changed files with 68 additions and 74 deletions
142
README.md
142
README.md
|
|
@ -1,96 +1,90 @@
|
|||
# Obsidian Sample Plugin
|
||||
# Cypher Plugin for Obsidian
|
||||
|
||||
This is a sample plugin for Obsidian (https://obsidian.md).
|
||||
Transform your Obsidian notes into an enigmatic, fun, and visually distinct experience with the **Cypher Text Plugin**! With a simple toggle, you can hide your text in icon-based ciphers, ideal for adding a layer of mystery to your notes or just keeping things visually intriguing.
|
||||
|
||||
This project uses TypeScript to provide type checking and documentation.
|
||||
The repo depends on the latest plugin API (obsidian.d.ts) in TypeScript Definition format, which contains TSDoc comments describing what it does.
|
||||
 <!-- Optional: Add a demo image or GIF showcasing the plugin -->
|
||||
|
||||
**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
|
||||
## Features
|
||||
|
||||
This sample plugin demonstrates some of the basic functionality the plugin API can do.
|
||||
- Adds a ribbon icon, which shows a Notice when clicked.
|
||||
- Adds a command "Open Sample Modal" which opens a Modal.
|
||||
- Adds a plugin setting tab to the settings page.
|
||||
- Registers a global click event and output 'click' to the console.
|
||||
- Registers a global interval which logs 'setInterval' to the console.
|
||||
- **Toggle Cypher Mode On/Off**: Easily switch between normal text and cyphered text with a click.
|
||||
- **Real-Time Cypher Conversion**: Watch your text transform as you type, with plain text for input and auto-cyphered output.
|
||||
- **Unique Upper and Lowercase Icons**: Each letter has a distinct symbol, making every word visually unique.
|
||||
- **Backspace Handling**: Intelligent handling of spaces and backspacing, so your text remains clean and easy to manage.
|
||||
- **Simple Reversion**: Toggle off the cypher to instantly revert to plain text without losing any data.
|
||||
|
||||
## First time developing plugins?
|
||||
## Installation
|
||||
|
||||
Quick starting guide for new plugin devs:
|
||||
### From the Obsidian Community Plugins
|
||||
|
||||
- Check if [someone already developed a plugin for what you want](https://obsidian.md/plugins)! There might be an existing plugin similar enough that you can partner up with.
|
||||
- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it).
|
||||
- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
|
||||
- Install NodeJS, then run `npm i` in the command line under your repo folder.
|
||||
- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.
|
||||
- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`.
|
||||
- Reload Obsidian to load the new version of your plugin.
|
||||
- Enable plugin in settings window.
|
||||
- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
|
||||
1. Open **Obsidian** and go to **Settings** > **Community Plugins**.
|
||||
2. Search for **Cypher Text Plugin**.
|
||||
3. Click **Install** and then **Enable** the plugin.
|
||||
|
||||
## Releasing new releases
|
||||
### Manual Installation
|
||||
|
||||
- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
|
||||
- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible.
|
||||
- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
|
||||
- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.
|
||||
- Publish the release.
|
||||
1. Download the latest release from the [Releases](https://github.com/aths7/cypher/releases) page.
|
||||
2. Unzip the folder and place it in your Obsidian vault's plugins folder: `.obsidian/plugins/cypher`.
|
||||
3. Go to **Settings** > **Community Plugins** and enable the **Cypher Text Plugin**.
|
||||
|
||||
> You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`.
|
||||
> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
|
||||
## Usage
|
||||
|
||||
## Adding your plugin to the community plugin list
|
||||
1. **Activate Cypher Mode**: Click on the dice icon in the ribbon (sidebar) to activate or deactivate the cypher mode.
|
||||
- **Activated**: Your text will transform into symbol-based icons.
|
||||
- **Deactivated**: All cyphered text reverts to plain text for easy reading and editing.
|
||||
2. **Transform Selected Text**: Use the command `Transform Selected Text to Cypher` to convert specific text selections into symbols, even if cypher mode is off.
|
||||
3. **Real-Time Cypher as You Type**: While cypher mode is on, your text will be visually transformed after typing, adding three spaces between words and intelligently handling backspaces.
|
||||
|
||||
- Check the [plugin guidelines](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines).
|
||||
- Publish an initial version.
|
||||
- Make sure you have a `README.md` file in the root of your repo.
|
||||
- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
|
||||
## Customization
|
||||
|
||||
## How to use
|
||||
Cypher Text Plugin offers customization to fit your preferences:
|
||||
|
||||
- Clone this repo.
|
||||
- Make sure your NodeJS is at least v16 (`node --version`).
|
||||
- `npm i` or `yarn` to install dependencies.
|
||||
- `npm run dev` to start compilation in watch mode.
|
||||
- **Choose Cypher Style**: Select different cypher styles to modify the appearance of transformed text (e.g., different icon sets for letters).
|
||||
|
||||
## Manually installing the plugin
|
||||
## Example
|
||||
|
||||
- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
|
||||
|
||||
## Improve code quality with eslint (optional)
|
||||
- [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code.
|
||||
- To use eslint with this project, make sure to install eslint from terminal:
|
||||
- `npm install -g eslint`
|
||||
- To use eslint to analyze this project use this command:
|
||||
- `eslint main.ts`
|
||||
- eslint will then create a report with suggestions for code improvement by file and line number.
|
||||
- If your source code is in a folder, such as `src`, you can use eslint with this command to analyze all files in that folder:
|
||||
- `eslint .\src\`
|
||||
|
||||
## Funding URL
|
||||
|
||||
You can include funding URLs where people who use your plugin can financially support it.
|
||||
|
||||
The simple way is to set the `fundingUrl` field to your link in your `manifest.json` file:
|
||||
|
||||
```json
|
||||
{
|
||||
"fundingUrl": "https://buymeacoffee.com"
|
||||
}
|
||||
```plaintext
|
||||
Hello World
|
||||
```
|
||||
|
||||
If you have multiple URLs, you can also do:
|
||||
With Cypher Mode ON, becomes:
|
||||
|
||||
```json
|
||||
{
|
||||
"fundingUrl": {
|
||||
"Buy Me a Coffee": "https://buymeacoffee.com",
|
||||
"GitHub Sponsor": "https://github.com/sponsors",
|
||||
"Patreon": "https://www.patreon.com/"
|
||||
}
|
||||
}
|
||||
```plaintext
|
||||
🌺💧🍃🍃🔺 🔷🔶🌻🍃⬛
|
||||
```
|
||||
|
||||
## API Documentation
|
||||
This transformation allows for playful exploration of text without compromising readability when toggled off.
|
||||
|
||||
See https://github.com/obsidianmd/obsidian-api
|
||||
## Development
|
||||
|
||||
1. Clone the repository:
|
||||
```bash
|
||||
git clone https://github.com/aths7/cypher.git
|
||||
```
|
||||
2. Navigate to the plugin directory:
|
||||
```bash
|
||||
cd cypher-text-plugin
|
||||
```
|
||||
3. Install dependencies:
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
4. Build the plugin:
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! If you have ideas for improvements or new features, feel free to open an issue or submit a pull request.
|
||||
|
||||
## Feedback and Support
|
||||
|
||||
If you encounter issues or have suggestions, please [open an issue](https://github.com/aths7/cypher/issues) on GitHub.
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
---
|
||||
|
||||
Enjoy adding a dash of mystery and style to your notes with the Cypher Text Plugin!
|
||||
|
|
|
|||
Loading…
Reference in a new issue