Skip to main content

A simple markdown server.

Project description

Markdown-server is a simple web application. It converts markdown file to HTML and response by text/html.

How to use

Runtime Environment

Python:

3.7

pip:

19.1.1

Library Dependencies

See requirements.txt.

Just try

Start server

You don’t need any special preparation to try to start server. Just execute below commands.

$ git clone https://github.com/ohbarye/markdown-server
$ cd markdown-server
$ virtualenv .venv
$ source .venv/bin/activate
(.venv)$ pip install -r requirements.txt
(.venv)$ markdownserver
    Bottle v0.12.8 server starting up (using WSGIRefServer())...
    Listening on http://localhost:8009/

Or, you can install from PyPi.

(.venv)$ pip install markdown-server
(.venv)$ markdownserver
    Bottle v0.12.8 server starting up (using WSGIRefServer())...
    Listening on http://localhost:8009/

If server start up successfully, browse below URL and check the converted result.

$ open http://localhost:8009/sample.md

Only Conversion

Additionally, You can use the conversion function alone.

(.venv)$ convert source_md_file target_html_file

Do as you like

  • Markdown server purvey http://host/[file_name] URL. This corresponds to resources/markdown/[file_name].You can put any markdown file here.

  • Converted file will be placed to resources/html directory. Generated html file includes CSS so it’s ease to distribute.

  • Environment variables like host name or port number are set in env.py. Edit arbitrarily.

    ms_port        = '8009'
    ms_host        = 'localhost'
  • The default markdown engine is Github flavored Markdown. If you want to use another style, add CSS and edit env.py.

    css_name       = 'github.css'
    markdown_type  = 'gfm'

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

markdown-server-0.1.4.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

markdown_server-0.1.4-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

Details for the file markdown-server-0.1.4.tar.gz.

File metadata

  • Download URL: markdown-server-0.1.4.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for markdown-server-0.1.4.tar.gz
Algorithm Hash digest
SHA256 ea1929f92ec43e33e60ea31c89d69ebbe719a0f5f7a313bd2a61594a4a5ad4f9
MD5 977cb2db780633680b557cc3aed491c1
BLAKE2b-256 d6a01e56001daa42ab90a3c1be389ac17a4b7389ad9b3d53dc03a3222c6fb483

See more details on using hashes here.

File details

Details for the file markdown_server-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: markdown_server-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 16.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.4

File hashes

Hashes for markdown_server-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 92cd33b3ef92dfff88dc712df489deb8165e8d279f7543b36300cf88d927dc5a
MD5 b3efcc54444b49e5fcb6115e403fbae8
BLAKE2b-256 84066d0443b0d7b1b2bab90a704d6848ff1441cd4dfc19770296d91edd507957

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page