static-cling

command module
v0.0.0-...-82bc1ab Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 14, 2021 License: Apache-2.0 Imports: 4 Imported by: 0

README

static-cling

A no nonsense static static site generator

Go Report Card license

Motivation

There are many existing static site generators and all of them have one issue or another that makes them not something that I want to use. Some of these things include:

  • Not supporting HAML as a template language
  • Forcing the use of template languages that are hard to write
  • Enforcing a complicated or unintuitive project structure
  • Having so many features that it's possible to achieve the same result, with various solutions of differing complexity
  • Requiring many additional dependencies to handle various features that you may or may not use (ie. scripting languages, libraries)

Goals

  • Easy to use
  • As few features as necessary
  • Support multiple templating languages:
    • Go's html/template
    • HAML (WIP)
  • Support multiple content languages:
    • HAML (WIP)
    • HTML
    • Markdown (blackfriday)
    • TimberText (my own language)
  • Documentation will be self-hosted as a static-cling project
  • Stretch Goals
    • CSS Preprocessor Support
    • RSS Feeds
      • Podcast Support
  • A+ Rating on Report Card

Requirements

Compile-Time
  • Go 1.16 (tested)
  • Make

Installation

  1. Clone repo and enter its directory
  2. make
  3. sudo make install

Usage

Under construction

License

Copyright 2021 Bryan T. Meyers [email protected]

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL