https://github.com/thlorenz/readarepo-zip

Convert a git repo into html pages to read anywhere.
https://github.com/thlorenz/readarepo-zip

Last synced: 15 days ago
JSON representation

Convert a git repo into html pages to read anywhere.

• Host: GitHub
• URL: https://github.com/thlorenz/readarepo-zip
• Owner: thlorenz
• Created: 2012-05-29T10:58:00.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2012-09-25T01:11:31.000Z (about 12 years ago)
• Last Synced: 2024-10-17T23:54:45.159Z (20 days ago)
• Language: Python
• Size: 4.56 MB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
**Table of Contents**  *generated with [DocToc](http://doctoc.herokuapp.com/)*

- [What ](#what)

- [How](#how)

- [Install](#install)

- [Run](#run)

	- [Convert a repository](#convert-a-repository)

	- [Convert a folder](#convert-a-folder)

- [API](#api)

# What 

Convert a git repo into html pages to read anywhere.

# How

Given a repository url or a local folder, it will convert all files into syntax

highlighted `.html` files, while maintaining the original folder structure.

Finally it will create a zip file of all highlighted files which you can then

read on a reader like iPad, e.g., with

[GoodReader](http://itunes.apple.com/app/id363448914?mt=8)

# Install

Requires python to be [installed](http://www.python.org/getit/).

    

    npm install readarepo-zip

# Run

    

## Convert a repository

Convert a github repository use `readarepo-zip.js`.

Running it without parameters will print the following guide:

    > node ./readarepo-zip.js

    Options:

    -u, --url          [required]

    -t, --target       [default: "./tmp"]

    -d, --directories  [default: "!.git,!node_modules"]

    -f, --files        

    -h, --highlighter  [default: "pygments"]

    -l, --loglevel     [default: "info"]

    Missing required arguments: u

As an example, in order to convert this repository you would do:

    node readarepo-zip.js -u https://github.com/thlorenz/readarepo-zip -d '!.git,!3rd' 

- `-d '!.git,!3rd'` makes sure we don't attempt to convert the '.git' folder or

the '3rd' which (contains a copy of the [pygments](http://pygments.org)

library.

- read more about file and directory filters on the [fsrec

repository](https://github.com/thlorenz/fsrec) since readarepo-zip uses it under

the hood.

## Convert a folder

In order to convert all files found within a folder on your machine, use `readafolder-zip.js`.

Running it without parameters will print the following guide:

    > node readafolder-zip

    Options:

    -s, --source       [required]

    -t, --target       [default: "./tmp"]

    -d, --directories  [default: "!.git,!node_modules"]

    -f, --files        

    -h, --highlighter  [default: "pygments"]

    -l, --loglevel     [default: "info"]

    Missing required arguments: s

As an example, in order to convert folder './foo' (excluding '.svn' folders) and store it inside './foo_converted', you would do:

    node readafolder-zip.js -s ./foo -t ./foo_converted -d '!.svn'

- filters work the same as explained above

## Available highlighters

You can currently choose from three highlighters:

- [pytments](http://pygments.org/) by specifying `-h pygments` (requires python to be installed)

- [highlightjs](http://softwaremaniacs.org/soft/highlight/en/) by specifying `-h hljs` (doesn't support line numbers)

- [SyntaxHighlighter](http://alexgorbatchev.com/SyntaxHighlighter/) by specifying `-h sh`

# API

In order to support using **readarepo-zip** as a service, it exposes all necessary

functions via the [service module](./readarepo-zip/blob/master/lib/service.js).

As a guide on how to use it look inside

[readarepo-zip.js](./readarepo-zip/blob/master/readarepo-zip.js) and

[readafolder-zip.js](./readarepo-zip/blob/master/readafolder-zip.js).

Most functions take a function as last parameter which will be invoked once the task is complete.

Here is a list of the ones you may most likely use:

- convertFolder:  `function (rootPath, opts, convertedFolderCb)`

- cloneAndConvert: ` function (opts, clonedAndConvertedCb)`

- startPygmentsService: `function(cb)`

- stopPygmentsService: `function()`

For more information - *soon* - you may also look at the

[readarepo-web](https://github.com/thlorenz/readarepo-web) project which

leverages this API to expose **readarepo-zip** as a service on the web.