https://github.com/lutzroeder/minimal

Website and blog generator for Go, Node.js or Python
https://github.com/lutzroeder/minimal

blog-engine go nodejs python static-site-generator

Last synced: 17 days ago
JSON representation

Website and blog generator for Go, Node.js or Python

• Host: GitHub
• URL: https://github.com/lutzroeder/minimal
• Owner: lutzroeder
• License: mit
• Created: 2017-01-01T00:21:28.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2021-07-12T09:00:14.000Z (over 3 years ago)
• Last Synced: 2024-10-23T06:07:06.635Z (26 days ago)
• Topics: blog-engine, go, nodejs, python, static-site-generator
• Language: Go
• Homepage: https://www.lutzroeder.com/projects
• Size: 522 KB
• Stars: 141
• Watchers: 7
• Forks: 37
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Minimal

Minimal is a static personal website and blog generator for Go, Node.js and Python. It has no external dependencies and requires only a few hundred lines of code to run.

Example blogs are hosted on Netlify using the [default](https://lutzroeder.github.io/minimal/default), [profile](https://lutzroeder.github.io/minimal/profile) and [developer](https://lutzroeder.github.io/minimal/developer) themes.

## Getting Started

To get started, [fork](https://help.github.com/articles/fork-a-repo) this repository and create a local [clone](https://help.github.com/articles/cloning-a-repository).

Modify `./content.json` to your liking (symbol codes for social links can be found [here](http://drinchev.github.io/monosocialiconsfont)). 

To build locally and launch a simple web server run **either** of the following: 

* Install [Node.js](https://nodejs.org/en/download) and run `./task start --runtime node`.

* Install [Go](https://golang.org/doc/install) and run `./task start --runtime go`.

* Install [Python](https://www.python.org/downloads/) and run `./task start --runtime python`.

The default `runtime` can be configured via `./task.cfg`.

## Deployment

To deploy to a production enviroment set the deploy `target` in `./task.cfg` and update the corresponding `.cfg` file in the `./deploy` folder, then run `./task deploy` to build and deploy the site.

To host the repository on [Netlify](http://www.netlify.com) set the `target` to `netlify`. In your site settings (Settings > Build & Deploy > Continuous Deployment) update Build Command to `./task deploy` and Publish Directory to `build`.