https://github.com/naoty/mdserve

A web server providing RESTful API for markdown contents
https://github.com/naoty/mdserve

Last synced: 21 days ago
JSON representation

A web server providing RESTful API for markdown contents

• Host: GitHub
• URL: https://github.com/naoty/mdserve
• Owner: naoty
• License: mit
• Created: 2019-09-09T14:55:38.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-09-14T07:57:35.000Z (over 5 years ago)
• Last Synced: 2024-10-22T13:59:20.299Z (2 months ago)
• Language: Go
• Size: 21.5 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mdserve

A web server providing RESTful API for markdown contents

## Usage

```bash

$ mdserve 

```

This command starts a web server. It provides following endpoints.

* **`/path/to/dir/`**: return JSON response including list of contents.

* **`/path/to/dir/contents.json`**: return JSON response including a content.