levibostian / static

Download, preview, and deploy dynamic websites to GitHub pages.

static

Static website generator to push dynamic website to GitHub pages for static hosting.

Generate Static Pages from existing static/dynamic website. Preview. Deploy to GitHub Pages.

The interface

setup Use if you currently do not have a git repo created on your machine. setup creates a git repo for the website to push up to GitHub pages.

add Like setup but use this if you already have a git repo created.

remove Removes existing site from your site config file. Does not delete content, just removes website from static's site list.

generate Generates static HTML files from your locally running website so you can then push up to GitHub pages.

preview Before deploying to GitHub pages, preview your changes locally on localhost:9000.

deploy Commits and pushes git changes to GitHub repository on the appropriate branch. Make sure to run generate before this.

add-domain Adds CNAME file to local directory where site is located to allow a custom domain on your website.

Installation

First, make sure you follow the requirements section before continuing on!

1. Clone the repo: git clone [email protected]:levibostian/static.git
2. Go into the root of static: cd static.
3. Install ruby dependencies: bundler install
4. Now run the program. Use this command to check out what static can do: ruby lib/main.rb -h

Requirements

• the ruby programming language

• wget: Use brew install wget to install wget on your Mac. Installer for Windows wget is available by default on most linux distributions.

• bundler

Contributing

If you are hoping to add an even better experience to static, check out the existing issues or simply fork the repo, make some edits, and make a pull request.

static's Issues

Static Commands

Hey Levi!
I'm attempting to use static but after cloning it and running the installs, bash still says that the static command doesn't exist... ruby lib/main.rb -h gives me the commands but none of them work. Am I missing a step here? What do you mean by run the program in the installation instructions?

Change "local-url" references to "url"

Turns out, static can be used for more then just localurl links. so change all references to just url and update the readme to reflect this.

New GitHub pages updates

https://github.com/blog/2228-simpler-github-pages-publishing

Get static program setup to install binary for bash to pick up.

Tired of typing ruby lib/main.rb to run the program. Would love to just do static in bash.

sh.exe: static command not found

Thx for your tool but I am having some issues on windows 8.1

After typing in my command prompt(git shell):
static generate --site=127.0.0.1:2368

I got this error:
sh.exe: static command not found

Do I have to include something in my PATH ?
Or did I do a mistake while typing the command ?

Thanks in advance for your help :)

Allow user to not require you download all docs from external CDN source

I am adding an option that allows you to download an entire site (even from external CDN sources) to make site completely offline capable.

But sometimes I do not want this, so make option that allows user not to do this (maybe a '-a' flag or something)