{"id":16069044,"url":"https://github.com/gavinmn/obsidian-rename-untitled","last_synced_at":"2025-07-20T09:36:34.727Z","repository":{"id":104822868,"uuid":"465158664","full_name":"gavinmn/obsidian-rename-untitled","owner":"gavinmn","description":null,"archived":false,"fork":false,"pushed_at":"2022-03-02T06:00:02.000Z","size":18,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-10T13:23:58.912Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gavinmn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-02T04:40:29.000Z","updated_at":"2023-04-22T06:07:49.000Z","dependencies_parsed_at":"2023-05-30T08:00:11.344Z","dependency_job_id":null,"html_url":"https://github.com/gavinmn/obsidian-rename-untitled","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"gavinmn/obsidian-sample-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gavinmn%2Fobsidian-rename-untitled","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gavinmn%2Fobsidian-rename-untitled/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gavinmn%2Fobsidian-rename-untitled/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gavinmn%2Fobsidian-rename-untitled/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gavinmn","download_url":"https://codeload.github.com/gavinmn/obsidian-rename-untitled/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247291947,"owners_count":20914952,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-09T06:41:27.538Z","updated_at":"2025-04-05T05:27:43.285Z","avatar_url":"https://github.com/gavinmn.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Obsidian Sample Plugin\r\n\r\nThis is a sample plugin for Obsidian (https://obsidian.md).\r\n\r\nThis project uses Typescript to provide type checking and documentation.\r\nThe repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does.\r\n\r\n**Note:** The Obsidian API is still in early alpha and is subject to change at any time!\r\n\r\nThis sample plugin demonstrates some of the basic functionality the plugin API can do.\r\n- Changes the default font color to red using `styles.css`.\r\n- Adds a ribbon icon, which shows a Notice when clicked.\r\n- Adds a command \"Open Sample Modal\" which opens a Modal.\r\n- Adds a plugin setting tab to the settings page.\r\n- Registers a global click event and output 'click' to the console.\r\n- Registers a global interval which logs 'setInterval' to the console.\r\n\r\n### First time developing plugins?\r\n\r\nQuick starting guide for new plugin devs:\r\n\r\n- Make a copy of this repo as a template with the \"Use this template\" button (login to GitHub if you don't see it).\r\n- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.\r\n- Install NodeJS, then run `npm i` in the command line under your repo folder.\r\n- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.\r\n- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`.\r\n- Reload Obsidian to load the new version of your plugin.\r\n- Enable plugin in settings window.\r\n- For updates to the Obsidian API run `npm update` in the command line under your repo folder.\r\n\r\n### Releasing new releases\r\n\r\n- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.\r\n- 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.\r\n- 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\r\n- 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.\r\n- Publish the release.\r\n\r\n\u003e 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`.\r\n\u003e The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`\r\n\r\n### Adding your plugin to the community plugin list\r\n\r\n- Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md\r\n- Publish an initial version.\r\n- Make sure you have a `README.md` file in the root of your repo.\r\n- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.\r\n\r\n### How to use\r\n\r\n- Clone this repo.\r\n- `npm i` or `yarn` to install dependencies\r\n- `npm run dev` to start compilation in watch mode.\r\n\r\n### Manually installing the plugin\r\n\r\n- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.\r\n\r\n### Improve code quality with eslint (optional)\r\n- [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. \r\n- To use eslint with this project, make sure to install eslint from terminal:\r\n  - `npm install -g eslint`\r\n- To use eslint to analyze this project use this command:\r\n  - `eslint main.ts`\r\n  - eslint will then create a report with suggestions for code improvement by file and line number.\r\n- 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:\r\n  - `eslint .\\src\\`\r\n\r\n\r\n### API Documentation\r\n\r\nSee https://github.com/obsidianmd/obsidian-api\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgavinmn%2Fobsidian-rename-untitled","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgavinmn%2Fobsidian-rename-untitled","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgavinmn%2Fobsidian-rename-untitled/lists"}