Skip to main content

CodeShow turns a directory of code into a static website suitable for use in presentations.

Project description

# CodeShow

CodeShow turns a directory of code into a static website suitable for use in presentations. It uses [pygments](http://pygments.org) for syntax highlighting. In directories that include a readme.md or readme.txt, the readme contents will be displayed under the directory listing.

Passing –site44 generates content optimized for hosting on Site44:

  1. No .html or .txt file extensions are appended to files. This makes for prettier URLs.
  2. A mimetypes.site44.txt file is generated that enforces HTML and plain text content types for those pretty URLs.

See [codeshow.site44.com](http://codeshare.site44.com) for an example of the output, or get the code at [github.com/smarx/codeshow](https://github.com/smarx/codeshow).

## Installation

Use pip install codeshow to install.

## Usage

usage: codeshow [path] [<options>]

CodeShow turns a directory of code into a static website suitable for use in presentations.

positional arguments:
PATH path to the code project
optional arguments:
-h, --help show this help message and exit
-v, --version show program’s version number and exit
-o, --output PATH
 output path for generated website
-i, --ignore PATH
 relative path to skip (can be specified multiple times)
-f, --force if the output directory already exists, delete it first
-s, --site44 generate output for Site44 (generate mimetypes.site44.txt instead of using file extensions)

Project details


Release history Release notifications

History Node

0.2.2

History Node

0.2.1

This version
History Node

0.2.0

History Node

0.1.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
CodeShow-0.2.0.tar.gz (6.5 kB) Copy SHA256 hash SHA256 Source None Sep 11, 2012

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page