https://github.com/simplificator/simplificator-blog
https://github.com/simplificator/simplificator-blog
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/simplificator/simplificator-blog
- Owner: simplificator
- License: mit
- Created: 2019-12-11T18:16:04.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-01-15T17:12:31.000Z (over 1 year ago)
- Last Synced: 2025-01-15T19:42:25.436Z (over 1 year ago)
- Language: HTML
- Homepage: https://blog.simplificator.com
- Size: 37.7 MB
- Stars: 0
- Watchers: 6
- Forks: 2
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# The Simplificator blog
Production URL:
## Provisioning and deployment
The blog is hosted on [ZEIT](https://zeit.co), which automatically deploys on every push. ZEIT also renews TLS certificates on its own.
The latest commit on the `master` branch is deployed to production (`blog.simplificator.com`).
Commits to other branches are also deployed, but each deployment has its own URL. Look at the environments and status checks assigned to your pull requests.
## Development setup
```
npm install
npm run serve
```
The blog is powered by [Eleventy](https://www.11ty.dev).
Please open pull requests for new blogs or features.
## Guidelines for a new blog post
### File name
The articles are Markdown files stored in `content/posts/`.
The name of the file is used in the article permalink:
- use dashes instead of spaces
- use lower case US ASCII characters (a-z) and numbers (0-9)
Example file name: `encoding-hell-part-2.md`.
### Article metadata
Even though the articles are in the Markdown format, they should contain a YAML front matter. That is a collection of keys and values describing metadata about the article.
For example:
```
---
title: "User story mapping: a retrospective"
date: 2017-03-30
language: en
author: Jane Appleseed
tags:
- user-story-mapping
- projects
---
```
The front matter should have these fields:
- `title`: the blog post title, preferably surrounded by quotes.
- `date`: the publication date in `YYYY-MM-DD` format. This is used in the permalink.
- `language`: `en` or `de`. This is used to tell the browser and search engines which language is used, so that they don't need to guess.
- `author`: your name :)
Optional fields:
- `tags`: a list of tags for the blog post
### Images
Images are stored in `content/images/`.
Use the `image` [shortcode](https://www.11ty.dev/docs/shortcodes/) (defined in `.eleventy.js`) to insert an image in a post. For example:
```liquid
{% image "./content/images/sitincator-wireframes.png", "Early Sitincator wireframes" %}
```
The first argument is the relative path to the image file from the project root. The second argument is the alternative text that describes the image.
You could additionally include a caption that is displayed below the image:
```html
{% image "./content/images/first_website.png", "Screenshot of the first Simplificator website" %}
Our website in 2007
```