{"id":15017145,"url":"https://github.com/rooyca/markob","last_synced_at":"2025-04-23T14:49:00.657Z","repository":{"id":160779355,"uuid":"622708379","full_name":"Rooyca/markob","owner":"Rooyca","description":"Highlight your text and send it to your Obsidian vault. It automatically creates you a file with the name of the page.","archived":false,"fork":false,"pushed_at":"2023-08-23T17:20:12.000Z","size":286,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-30T00:41:19.376Z","etag":null,"topics":["docker","firefox","firefox-extension","highlight","highlight-text","obsidian","obsidian-md","pip"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Rooyca.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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-02T22:12:31.000Z","updated_at":"2024-04-18T15:35:31.000Z","dependencies_parsed_at":"2023-08-23T11:29:42.991Z","dependency_job_id":"a6e797d2-a8dd-4276-851b-579f57ff873d","html_url":"https://github.com/Rooyca/markob","commit_stats":{"total_commits":19,"total_committers":2,"mean_commits":9.5,"dds":"0.26315789473684215","last_synced_commit":"0c6c597ea596afa5015f1ed8c3f47ed6f4d02199"},"previous_names":["rooyca/markob-obsidian-highligter","rooyca/markob"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rooyca%2Fmarkob","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rooyca%2Fmarkob/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rooyca%2Fmarkob/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rooyca%2Fmarkob/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Rooyca","download_url":"https://codeload.github.com/Rooyca/markob/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250456992,"owners_count":21433723,"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":["docker","firefox","firefox-extension","highlight","highlight-text","obsidian","obsidian-md","pip"],"created_at":"2024-09-24T19:49:57.089Z","updated_at":"2025-04-23T14:49:00.634Z","avatar_url":"https://github.com/Rooyca.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# **markob** - Web Highlighter for Obsidian\n\n[![Docker image](https://github.com/Rooyca/markob/actions/workflows/deploy-image.yml/badge.svg?branch=main)](https://github.com/Rooyca/markob/actions/workflows/deploy-image.yml)\n\n\nWhile reading your favorite articles you can highlight your texts and send them to your Obsidian vault and it will automatically create a file with the name of the page. Saving what interests you has never been easier*.\n\n![highlighter](https://github.com/Rooyca/markob/blob/main/highlighter_obsidian.png)\n\n## Extension Installation\n\n### Firefox\n\n#### Firefox Browser Addons\n\n1. Go to [Firefox browser addons](https://addons.mozilla.org/en-US/firefox/addon/markob/)\n2. Install the extension\n\n#### Manual Installation\n\n1. Download the latest version from [here](Install.zip)\n2. Open `about:debugging` in Firefox\n3. Click on \"This Firefox\"\n4. Click on \"Load Temporary Add-on\"\n5. Select the `Install.zip` file\n\n## Running the server\n\n**Enviorment variables**\n\n| Variable | Description | Default |\n| -------- | ----------- | ------- |\n| `OBSIDIAN_PATH` | Path to your Obsidian vault | `/code/obsi/` |\n\n- **Befor running the server make sure you export the `OBSIDIAN_PATH` variable by running `export OBSIDIAN_PATH=/path/to/your/obsidian/vault`.**\n\n\n#### PIP\n\n1. Install the package\n\n```bash\npip install markob\n```\n\n2. Run the server\n\n```bash\nmarkob\n```\n\n#### Docker\n\nIf you dont have docker installed go [**here**](https://docs.docker.com/engine/install/) and follow the instructions.\n\n1. Pull the image\n\n```bash\ndocker pull ghcr.io/rooyca/markob:main\n```\n\n2. Run the image\n\n```bash\ndocker run --rm -p 8888:8888 rooyca/markob:main\n```\n\nWhere `/home/USER/Documents/Obsidian/Highlights/` is the path to your Obsidian vault. Make sure to create your `Highlights` folder in your vault.\n\nIt's that simple!\n\n#### Docker build\n\nIf you want to build the docker image yourself you can do it by:\n\n1. Clone the repo\n\n```bash\ngit clone https://github.com/Rooyca/MarkOb\n```\n\n2. Build the image\n\n```bash\ndocker build -t markob .\n```\n\n3. Run the image\n\n```bash\ndocker run --rm -p 8888:8888 markob\n```\n\n#### Binary\n\nDownload the latest binary from the [release page](https://github.com/Rooyca/markob/releases/download/0.0.2/markob.bin), make it executable and run it.\n\n```bash\nchmod +x markob.bin\n./markob\n```\n\n#### Python (FastAPI Version)\n\n1. Clone the repo\n\n```bash\ngit clone https://github.com/Rooyca/MarkOb\n```\n\n2. Install the requirements\n\n```bash\npip install -r requirements.txt\n```\n\n3. Run the api\n\n```bash\nuvicorn server/server.old:app --bind 8888\n```\n\n#### Python (http.server Version)\n\n1. Clone the repo\n\n```bash\ngit clone https://github.com/Rooyca/MarkOb\n```\n\n2. Run the server\n\n```bash\npython server/server.py\n```\n\n---\n\n## Usage\n\n1. Highlight some text\n2. Right click on the text\n3. Select the option you want\n\nYou can also use the keyboard shortcuts:\n\n- `ALT + J` to send the highlighted text to Obsidian.\n- `ALT + K` to send the highlighted text + Tags.\n- `ALT + L` to send the highlighted text + Note.\n- `ALT + P` to send the highlighted text + Tags and a note.\n\n---\n\n## Contributing\n\nAll contributions are welcome! If you find a bug or have a suggestion please open an issue. If you want to contribute code please open a pull request.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frooyca%2Fmarkob","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frooyca%2Fmarkob","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frooyca%2Fmarkob/lists"}