Skip to content
This repository has been archived by the owner on Dec 14, 2024. It is now read-only.

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
ohbarye committed May 3, 2015
1 parent f85a63b commit 7185824
Show file tree
Hide file tree
Showing 6 changed files with 109 additions and 54 deletions.
File renamed without changes.
50 changes: 0 additions & 50 deletions README.md

This file was deleted.

70 changes: 70 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
===============
Markdown Server
===============

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

How to use
==========

--------------------
Runtime Environment
--------------------

:Python: 2.7.9
:pip: 6.1.1
:virtualenv: 12.1.1


--------------------
Library Dependencies
--------------------

See `requirements.txt`.

--------------------
Just try
--------------------

You don't need any special preparation to try to start server. Just execute below comands.

::

$ git clone https://github.com/ohbarye/markdown-server
$ cd markdown-server
$ virtualenv .venv
$ source .venv/bin/activate
(.venv)$ pip install -r requirements.txt
(.venv)$ mdsvr
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

--------------
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'
9 changes: 9 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
bottle==0.12.8
linecache2==1.0.0
Markdown==2.6.2
-e git+https://github.com/ohbarye/markdown-server@f85a63ba06ca7cb5beb59bd96153d7ba1fa867ae#egg=markdownserver-master
py-gfm==0.1.0
Pygments==2.0.2
six==1.9.0
traceback2==1.4.0
unittest2==1.0.1
3 changes: 3 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[aliases]
release = register sdist bdist_wheel upload

31 changes: 27 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,19 +1,42 @@
import os
from setuptools import setup, find_packages

def read_file(filename):
basepath = os.path.dirname(os.path.dirname(__file__))
filepath = os.path.join(basepath, filename)
if os.path.exists(filepath):
return open(filepath).read()
else:
return ''

setup(
name = 'markdownserver',
name = 'markdown-server',
version = '0.1.0',
description = 'A simple markdown server.',
long_description = read_file('README.rst'),
author = 'Masato Ohba',
author_email = '[email protected]',
url = 'https://github.com/ohbarye/markdown-server',
classifiers = [
'Topic :: Utilities',
'Development Status :: 4 - Beta',
'Framework :: Bottle',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python',
'Programming Language :: Python :: 2.7',
],
packages = find_packages(),
include_packages_data = True,
include_package_data = True,
keywords = ['web', 'markdown'],
license = 'MIT License',
install_requires = [
'bottle',
'Markdown',
'Pygments',
'py-gfm',
],

entry_points = """
[console_scripts]
markdownserver = markdownserver:main
mdsvr = markdownserver:main
""",
)

0 comments on commit 7185824

Please sign in to comment.