README
¶
Gotham - an awesome static site generator
Gotham is a static site generator that is extremely fast, efficient, and modular. It is written in Go and is a soft fork of Hugo.
Website | Contribution Guide | Twitter
Gotham is a very new project only recently forked from Hugo. Please stay tuned while we continue to update this readme and convert things over.
Overview
Gotham is a static HTML and CSS website generator written in [Go][]. It is optimized for speed, ease of use, and configurability. Gotham takes a directory with content and templates and renders them into a full HTML website.
Gotham relies on Markdown files with front matter for metadata, and you can run Gotham from any directory. This works well for shared hosts and other systems where you don’t have a privileged account.
Gotham renders a typical website of moderate size in a fraction of a second. A good rule of thumb is that each piece of content renders in around 1 millisecond.
Gotham is designed to work well for any kind of website including docs, blogs, marketing sites, newsletters, and more.
Supported Architectures
Currently, we provide pre-built Gotham binaries for Windows, Linux, FreeBSD, NetBSD, DragonFly BSD, Open BSD, macOS (Darwin), and Android for x64, i386 and ARM architectures.
Gotham may also be compiled from source wherever the Go compiler tool chain can run, e.g. for other operating systems including Plan 9 and Solaris.
Complete documentation is available at Gotham Documentation.
Choose How to Install
If you want to use Gotham as your site generator, simply install the Gotham binary. The Gotham binary have no external dependencies.
To contribute to the Gotham source code or documentation, you should fork the Gotham GitHub project and clone it to your local machine.
Finally, you can install the Gotham source code with go, build the binary yourself, and run Gotham that way.
Building the binary is an easy task for an experienced go getter.
Install Gotham as Your Site Generator (Binary Install)
Use the installation instructions in the Gotham documentation.
Build and Install the Binaries from Source (Advanced Install)
Prerequisite Tools
Fetch from GitHub
Gotham uses the Go Modules support built into Go 1.11 to build. The easiest is to clone Gotham in a directory outside of GOPATH, as in the following example:
mkdir $HOME/src
cd $HOME/src
git clone https://github.com/gothamhq/gotham.git
cd gotham
go install
If you are a Windows user, substitute the $HOME environment variable above with %USERPROFILE%.
Contributing to Gotham
For a complete guide to contributing to Gotham, see the Contribution Guide.
We welcome contributions to Gotham of any kind including documentation, themes, organization, tutorials, blog posts, bug reports, issues, feature requests, feature implementations, pull requests, answering questions on the forum, helping to manage issues, etc.
The Gotham community and maintainers are very active and helpful, and the project benefits greatly from this activity.
Asking Support Questions
We're creating a forum soon where users and developers can ask questions. You can use the GitHub Issue tracker to ask questions for now.
Reporting Issues
If you believe you have found a defect in Gotham or its documentation, use
the GitHub issue tracker to report the problem to the Gotham maintainers.
When reporting the issue, please provide the version of Gotham in use (gotham version).
Submitting Patches
The Gotham project welcomes all contributors and contributions regardless of skill or experience level. If you are interested in helping with the project, we will help you with your contribution. Gotham is a very active project with many contributions happening daily.
We want to create the best possible product for our users and the best contribution experience for our developers, we have a set of guidelines which ensure that all contributions are acceptable. The guidelines are not intended as a filter or barrier to participation. If you are unfamiliar with the contribution process, the Gotham team will help you and teach you how to bring your contribution in accordance with the guidelines.
For a complete guide to contributing code to Gotham, see the Contribution Guide.
Dependencies
Gotham stands on the shoulder of many great open source libraries, especially Hugo:
Directories