{"id":26489185,"url":"https://github.com/bur4kbey/obsidian-prettier","last_synced_at":"2025-03-20T07:20:15.039Z","repository":{"id":248325569,"uuid":"629719745","full_name":"BUR4KBEY/obsidian-prettier","owner":"BUR4KBEY","description":"A plugin for Obsidian to format markdown files using Prettier.","archived":false,"fork":false,"pushed_at":"2024-07-14T02:10:30.000Z","size":23,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-07-14T03:23:39.983Z","etag":null,"topics":["obsidian","obsidian-plugin","prettier"],"latest_commit_sha":null,"homepage":"","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/BUR4KBEY.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":"2023-04-18T22:25:06.000Z","updated_at":"2024-07-14T03:23:46.727Z","dependencies_parsed_at":"2024-07-14T03:23:41.900Z","dependency_job_id":"6310a047-5a36-48a2-ab80-52bda0cde5d8","html_url":"https://github.com/BUR4KBEY/obsidian-prettier","commit_stats":null,"previous_names":["bur4kbey/obsidian-prettier"],"tags_count":0,"template":false,"template_full_name":"obsidianmd/obsidian-sample-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BUR4KBEY%2Fobsidian-prettier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BUR4KBEY%2Fobsidian-prettier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BUR4KBEY%2Fobsidian-prettier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BUR4KBEY%2Fobsidian-prettier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BUR4KBEY","download_url":"https://codeload.github.com/BUR4KBEY/obsidian-prettier/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244567038,"owners_count":20473466,"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":["obsidian","obsidian-plugin","prettier"],"created_at":"2025-03-20T07:20:14.558Z","updated_at":"2025-03-20T07:20:15.027Z","avatar_url":"https://github.com/BUR4KBEY.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ✨ Obsidian Prettier\n\nThis is a plugin developed for [Obsidian](https://obsidian.md) to format markdown files using the popular code formatter [Prettier](https://prettier.io/).\n\n## 🛠️ Building the project\n\nFirstly, clone the project to your local disk by running the following command:\n\n```\ngit clone https://github.com/BUR4KBEY/obsidian-prettier.git\n```\n\nThen, install the dependencies using [yarn](https://yarnpkg.com):\n\n```\ncd obsidian-prettier\nyarn\n```\n\nNext, build the project by running the following command:\n\n```\nyarn build\n```\n\nAlternatively, you can run the `yarn dev` command for development purposes.\n\n## 🔌 Installation\n\nTo install the plugin, follow these steps:\n\n1. Navigate to your Obsidian vault and find the `.obsidian` folder.\n2. Create a new folder called `obsidian-prettier` inside the `.obsidian/plugins` directory.\n3. Copy `main.js` and `manifest.json` files into the `obsidian-prettier` folder.\n4. Enable the plugin from the Obsidian settings. (Community plugins \u003e Prettier Formatter)\n\n## 🚀 Usage\n\nTo use the plugin, you need to create a configuration file.\n\nCreate a new folder called `config`, and then create a new file called `prettierrc` inside that folder. (You can use any names you like)\n\nThe file content must follow this structure:\n\n````\n```json\n{\n    \"trailingComma\": \"none\",\n    \"tabWidth\": 4,\n    \"semi\": true,\n    \"singleQuote\": true,\n    \"arrowParens\": \"avoid\"\n}\n```\n````\n\nYou can write your Prettier configuration inside the JSON object.\n\nTo use this configuration file, specify the path by opening `Prettier Formatter` in the **Community Plugins** section and writing the path. (`config/prettierrc`)\n\nOnce you have set up the path, you can press `CTRL + P` to open the command palette and type `format document`, then run it to format the document according to your configuration.\n\n## ☕ Support\n\nIf you find this project useful and would like to support [me](https://github.com/BUR4KBEY), you can do so by visiting [my website](https://burakbey.dev).\n\n\u003ca href=\"https://burakbey.dev\" target=\"_blank\"\u003e\u003cimg src=\"https://burakbey.dev/github_support_snippet.png\" style=\"height: 56px !important;width: 200px !important;\" alt=\"Buy me a coffee\"\u003e\u003c/img\u003e\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbur4kbey%2Fobsidian-prettier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbur4kbey%2Fobsidian-prettier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbur4kbey%2Fobsidian-prettier/lists"}