gf4
/
www
2
0
Fork 0
Code Issues 2 Pull Requests Projects Releases Wiki Activity

Updated README.md

master
Keith Irwin 2021-06-21 10:47:30 -06:00
parent 45c994e36d
commit 36b67fc0b0
Signed by: ki9
GPG Key ID: DF773B3F4A88DA86
2 changed files with 6 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/FUNDING.yml vendored
View File

@ -1,2 +0,0 @@
# These are supported funding model platforms
open_collective: 11ty

43
README.md
View File

@ -1,48 +1,31 @@
# eleventy-base-blog
# GF4 Public Website
A starter repository showing how to build a blog with the [Eleventy](https://github.com/11ty/eleventy) static site generator.
Homepage for **Galactic Fortress 4**, served at [www.gf4.pw](https://www.gf4.pw/). This website was built with [Eleventy](https://github.com/11ty/eleventy) static site generator and forked from [its base blog starter project](https://github.com/11ty/eleventy-base-blog).
[![Build Status](https://travis-ci.org/11ty/eleventy-base-blog.svg?branch=master)](https://travis-ci.org/11ty/eleventy-base-blog)
## Demos
* [Netlify](https://eleventy-base-blog.netlify.com/)
* [GitHub Pages](https://11ty.github.io/eleventy-base-blog/)
* [Remix on Glitch](https://glitch.com/~11ty-eleventy-base-blog)
## Deploy this to your own site
These builders are amazing—try them out to get your own Eleventy site in a few clicks!
* [Get your own Eleventy web site on Netlify](https://app.netlify.com/start/deploy?repository=https://github.com/11ty/eleventy-base-blog)
* [Get your own Eleventy web site on Vercel](https://vercel.com/import/project?template=11ty%2Feleventy-base-blog)
## Getting Started
## Installation
### 1. Clone this Repository
```
git clone https://github.com/11ty/eleventy-base-blog.git my-blog-name
git clone https://gitea.gf4.pw/gf4/www.git gf4-www
```
### 2. Navigate to the directory
```
cd my-blog-name
cd gf4-www
```
Specifically have a look at `.eleventy.js` to see if you want to configure any Eleventy options differently.
### 3. Install dependencies
```
npm install
```
### 4. Edit _data/metadata.json
### 5. Run Eleventy
### 4. Build
```
npx eleventy
@ -62,17 +45,3 @@ Or in debug mode:
```
DEBUG=* npx eleventy
```
### Implementation Notes
* `about/index.md` shows how to add a content page.
* `posts/` has the blog posts but really they can live in any directory. They need only the `post` tag to be added to this collection.
* Add the `nav` tag to add a template to the top level site navigation. For example, this is in use on `index.njk` and `about/index.md`.
* Content can be any template format (blog posts needn’t be markdown, for example). Configure your supported templates in `.eleventy.js` -> `templateFormats`.
* Because `css` and `png` are listed in `templateFormats` but are not supported template types, any files with these extensions will be copied without modification to the output (while keeping the same directory structure).
* The blog post feed template is in `feed/feed.njk`. This is also a good example of using a global data files in that it uses `_data/metadata.json`.
* This example uses three layouts:
* `_includes/layouts/base.njk`: the top level HTML structure
* `_includes/base.njk`: the home page template (wrapped into `base.njk`)
* `_includes/layouts/post.njk`: the blog post template (wrapped into `base.njk`)
* `_includes/postlist.njk` is a Nunjucks include and is a reusable component used to display a list of all the posts. `index.njk` has an example of how to use it.