Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/donuts-are-good/markclient
client for the Markus document network
https://github.com/donuts-are-good/markclient
document go golang hacktoberfest markdown markus network
Last synced: 25 days ago
JSON representation
client for the Markus document network
- Host: GitHub
- URL: https://github.com/donuts-are-good/markclient
- Owner: donuts-are-good
- License: mit
- Created: 2023-07-26T04:58:06.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-07-26T23:36:10.000Z (over 1 year ago)
- Last Synced: 2024-12-23T10:38:08.097Z (about 1 month ago)
- Topics: document, go, golang, hacktoberfest, markdown, markus, network
- Language: Go
- Homepage:
- Size: 3.91 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
  
# MarkClient
MarkClient 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.
## Installation
To install MarkClient, clone the repository and build the project:
```shell
git clone https://github.com/donuts-are-good/markclient.git
cd markclient
go build
```
## Usage
MarkClient is a command-line tool and accepts a URL as its single argument:
```shell
./markclient http://localhost:88/myfile.md
```
The 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.
If 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.
## Offline Mode
In 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`.
The offline mode allows you to access previously viewed documents even when you're not connected to the network.
## Compatibility
MarkClient 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.
Contribution
Contributions 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.
Enjoy your journey through the Markus document network!
## license
MIT License 2023 donuts-are-good, for more info see license.md