{"id":18742140,"url":"https://github.com/donuts-are-good/markclient","last_synced_at":"2025-11-20T22:30:16.322Z","repository":{"id":184074568,"uuid":"670896965","full_name":"donuts-are-good/markclient","owner":"donuts-are-good","description":"client for the Markus document network","archived":false,"fork":false,"pushed_at":"2023-07-26T23:36:10.000Z","size":4,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-14T20:56:36.370Z","etag":null,"topics":["document","go","golang","hacktoberfest","markdown","markus","network"],"latest_commit_sha":null,"homepage":"","language":"Go","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/donuts-are-good.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}},"created_at":"2023-07-26T04:58:06.000Z","updated_at":"2023-10-05T17:39:16.000Z","dependencies_parsed_at":null,"dependency_job_id":"9cf7532e-3c03-42b4-b932-b4134f7e8140","html_url":"https://github.com/donuts-are-good/markclient","commit_stats":null,"previous_names":["donuts-are-good/markclient"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/donuts-are-good%2Fmarkclient","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/donuts-are-good%2Fmarkclient/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/donuts-are-good%2Fmarkclient/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/donuts-are-good%2Fmarkclient/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/donuts-are-good","download_url":"https://codeload.github.com/donuts-are-good/markclient/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239620929,"owners_count":19669790,"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":["document","go","golang","hacktoberfest","markdown","markus","network"],"created_at":"2024-11-07T16:06:36.328Z","updated_at":"2025-11-20T22:30:16.263Z","avatar_url":"https://github.com/donuts-are-good.png","language":"Go","readme":"![markclient](https://github.com/markusnetwork/.github/assets/96031819/fe5d9023-d98d-4fc3-8038-f93d54a72c69)\n![donuts-are-good's followers](https://img.shields.io/github/followers/donuts-are-good?\u0026color=555\u0026style=for-the-badge\u0026label=followers) ![donuts-are-good's stars](https://img.shields.io/github/stars/donuts-are-good?affiliations=OWNER%2CCOLLABORATOR\u0026color=555\u0026style=for-the-badge) ![donuts-are-good's visitors](https://komarev.com/ghpvc/?username=donuts-are-good\u0026color=555555\u0026style=for-the-badge\u0026label=visitors)\n\n# MarkClient\n\nMarkClient is a basic terminal-based client for browsing the Markus document network. It retrieves and displays Markdown documents served by a compatible server, like MarkServ.\n\n## Installation\n\nTo install MarkClient, clone the repository and build the project:\n\n```shell\ngit clone https://github.com/donuts-are-good/markclient.git\ncd markclient\ngo build\n```\n## Usage\n\nMarkClient is a command-line tool and accepts a URL as its single argument:\n\n```shell\n./markclient http://localhost:88/myfile.md\n```\n\nThe client will connect to the specified URL, retrieve the Markdown document, and display it in the terminal. Text formatting (such as bold, italics, and underlined text) is preserved using ANSI escape codes.\n\nIf the document contains links, they are numbered and listed at the bottom of the document. To follow a link, type its number and press Enter. To quit the client, type q and press Enter.\n\n## Offline Mode\n\nIn addition to displaying documents, MarkClient also saves them for offline reading. Each document is saved in the offline directory, under a subdirectory that matches the domain name from the URL. For example, a document from http://localhost:88/myfile.md would be saved as `offline/localhost/myfile.md`.\n\nThe offline mode allows you to access previously viewed documents even when you're not connected to the network.\n\n## Compatibility\n\nMarkClient is designed to work with any server that serves Markdown documents over HTTP, including MarkServ. However, it can also display any Markdown file that is accessible via an HTTP GET request.\nContribution\n\nContributions are always appreciated. If you see something, say something, and if you're motivated, please open an issue or a pull request on the GitHub repository.\n\nEnjoy your journey through the Markus document network!\n\n## license\nMIT License 2023 donuts-are-good, for more info see license.md\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdonuts-are-good%2Fmarkclient","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdonuts-are-good%2Fmarkclient","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdonuts-are-good%2Fmarkclient/lists"}