https://github.com/jamesmh/statica

Dead simple zero config static site generator
https://github.com/jamesmh/statica

Last synced: 2 months ago
JSON representation

Dead simple zero config static site generator

• Host: GitHub
• URL: https://github.com/jamesmh/statica
• Owner: jamesmh
• License: mit
• Created: 2019-04-29T16:09:48.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-05-02T19:36:53.000Z (over 5 years ago)
• Last Synced: 2024-10-09T14:47:36.548Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 325 KB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![logo](docs/img/logo.png)

Ever wish you could simply write some markdown files and convert them into web pages for your zero-fuss static site?

Introducing Statica - a dead simple zero config static site builder for people who don't need all that fancy "stuff". 

It's perfect for static sites when you simply want to write content in markdown and easily convert them to web pages!

![diagram](docs/img/diagram.png)

# Install

`npm install -g statica`

# Usage

## Create The Template File

First, you need a template that represents the "outer shell" of your HTML site.

Create a file `_template.html` in the root of your site's folder.

Next, just put whatever HTML you want into it!

## Injecting Content

Specify where content will be injected (from your markdown files) by adding the following to your template file:

``

The outer HTML might look like:

```html

    
This is my header

    

    

        This is my footer

    


```

## Writing Content

Write your markdown files (with an extension `.md`) anywhere you like. When compiled, each markdown file will be converted into an HTML file.

All other non-markdown files (HTML, JS, CSS, images, etc.) will be copied into `./www` for you too.

For example, your site layout might look like:

![pre-compiled](docs/img/pre-compiled.png)

After generating the site, the compiled layout will be (inside `./www`):

![pre-compiled](docs/img/compiled.png)

## Build It!

When installed as a global npm tool, open a terminal from the root of your site then run `statica`.

The compiled web site will be copied to a `www` folder.

![terminal](docs/img/terminal-img.png)

# Q&A

## Can I add plain HTML files?

Yes! Statica will copy them over to the `www` folder for you when building. This might be useful for one-off pages that do differ quite a bit from your overall template.

## Where do I put my site's assets (JS, CSS, etc.)?

Anywhere you want - except directly in the `www` folder since this is generated for you.

## Can I Use NPM Modules On My Site?

Sure! Statica will ignore your `node_modules` folder when building your site. Just make sure your compiled files (via webpack, etc.) are being referenced in your HTML pages.

## My Assets (JS, CSS) aren't working in my compiled site?

Are you using relative paths?