Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 87 lines (53 sloc) 4.087 kB
e08e5d3 @rthauby stay on target...
authored
1 ### Paige.js - *Painless page generation for Github code*
2
47bee4e @rthauby stay on target...
authored
3 Paige.js is a simple npm package for creating instant [Github Pages](http://pages.github.com/) without having to deal with any HTML *or* CSS coding. Paige let's you just focus on your code while providing a clean and presentable face for your project. The project page for Paige, itself, was generated with paige.js.
4
cded11b @sumbach Minor punctuation fix
sumbach authored
5 Paige is largely influenced by [Docco](http://jashkenas.github.com/docco/) and [Underscore](http://documentcloud.github.com/underscore/). The idea behind this project was to—in a sense—extend the wonderful functionality of Docco, and take it one step further as a more fully-featured project site. As such, Paige uses Docco for its source-file annotation, and its style is inspired heavily on the beauty and simplicity of the Underscore website. Not only that, but they are both direct dependencies of this project as well.
47bee4e @rthauby stay on target...
authored
6
7 Paige.js is [hosted on Github](https://github.com/rthauby/Paige). Please feel free to mess around with it and let me know of any bugs you find. Also you can always reach me on twitter [@rthauby](http://www.twitter.com/rthauby).
e08e5d3 @rthauby stay on target...
authored
8
c6933f3 @rthauby added link to project page in Readme file
authored
9 ### Demo
10
11 You're either reading this at the [project page itself](http://rthauby.github.com/Paige/), or on the Github repo site. If it's the latter, you can see the output of running paige against this very Readme file [here](http://rthauby.github.com/Paige/). If it's the former, well, you're looking at it.
12
e08e5d3 @rthauby stay on target...
authored
13 ### Installation Instructions
14
19be4d2 @rthauby included docco as part of the source. Now calling it rocco
authored
15 You'll be needing [Node.js](http://nodejs.org/) and [Pygments](http://pygments.org/). [Underscore](http://documentcloud.github.com/underscore/) is included as a package dependency. To install Paige.js:
47bee4e @rthauby stay on target...
authored
16
e08e5d3 @rthauby stay on target...
authored
17 `` sudo npm install paige ``
18
47bee4e @rthauby stay on target...
authored
19 ... then you can just do:
20
21 `` paige path/to/config ``
22
23 ... and go have a beer or two.
24
25 ### Configuration
26
27 Paige takes one argument only, and it's the location to a configuration file. Alternatively you can just skip the location of this file, and Paige will default to *paige.config* at the root of your project. The configuration file must be in JSON format.
28
29 A basic configuration file looks like this:
30
b8a35f9 @daffl Readme update
daffl authored
31 {
32 "title" : "Paige.js",
33 "content_file" : "README.mdown",
34 "include_index" : true,
35 "docco_files" : "src/*.coffee",
36 "header" : "Paige.js",
37 "subheader" : "The quickie-wiki Github project page generator",
38 "background" : "diagonal-noise",
40c6247 @rthauby couple of features added by community included for next npm release
authored
39 "github" : "https://github.com/rthauby/Paige"
b8a35f9 @daffl Readme update
daffl authored
40 }
47bee4e @rthauby stay on target...
authored
41
42 The properties here are:
43
44 - *title*: Title for the page... As in, in the `<head>` tag
45 - *content_file*: path to the file were your project page main content resides.
46 - *include_index*: Do you want to list out the project files a-la-docco?
47 - *docco_files*: If so, where are they?
48 - *header*: Main header for the page.
49 - *subheader*: Your tagline goes here.
50 - *background*: Eye candy. Available flavors are: bright-squares, felt, whitey, diagonal-noise, circles, project-paper. All pattern sourced from the brilliant [Subtle Patterns](http://subtlepatterns.com/)
b8a35f9 @daffl Readme update
daffl authored
51 - *github*: The URL to the GitHub repository, showing the "Fork me on GitHub" ribbon
47bee4e @rthauby stay on target...
authored
52
32ac049 @rthauby minor language tweaks and info
authored
53 ### Known Issues
54
55 - Docco file generation supported only on unix-based system.
56 - Index of files is not ordered alphabetically.
57
2d0a89d @rthauby incorporated docco into the paige project and modified slightly to pr…
authored
58 ### License
59
60 This entire project is [MIT licensed](http://www.opensource.org/licenses/mit-license.php).
61
47bee4e @rthauby stay on target...
authored
62 ### Change Log
63
8cd1952 @rthauby had to bump the version number one more
authored
64 #### 0.1.7
40c6247 @rthauby couple of features added by community included for next npm release
authored
65
66 - Replacing github syntax highlighted code blocks with showdown friendly pre tags. Many thanks to [DamonOehlman](https://github.com/DamonOehlman)
67 - Add GitHub repository URL config for "Fork me on GitHub" ribbon. Many thanks to [daffl](https://github.com/daffl)
68
4a6e2b2 @rthauby updated npm package to include mitchellrj fix to argv
authored
69 #### 0.1.5
70
40c6247 @rthauby couple of features added by community included for next npm release
authored
71 Fixed - Correct process.ARGV. Should be process.argv. Many thanks to [mitchellrj](https://github.com/mitchellrj)
4a6e2b2 @rthauby updated npm package to include mitchellrj fix to argv
authored
72
2d0a89d @rthauby incorporated docco into the paige project and modified slightly to pr…
authored
73 #### 0.1.4
74
75 Incorporated Docco within the Paige project itself for further customization and integration. For now, added custom output directory.
76
1868312 @rthauby fixed a few styling issues with headers and code-pre tags
authored
77 #### 0.1.3
78
79 Fixed styling issues with headers and `code/pre` tags
80
32ac049 @rthauby minor language tweaks and info
authored
81 #### 0.1.2
82
83 Minor language tweaks and info.
84
47bee4e @rthauby stay on target...
authored
85 #### 0.1.0
e08e5d3 @rthauby stay on target...
authored
86
47bee4e @rthauby stay on target...
authored
87 Initial release of Paige.js
Something went wrong with that request. Please try again.