Commit 74b0cbf5 authored by Laura Kalbag's avatar Laura Kalbag

Improve the readme for this project with description and install

Towards starter-blog-theme#58
parent d9575be3
......@@ -2,7 +2,14 @@
Default files to be included in the `.hugo` folder of every generated starters site.
## `/config`
## Contents:
- `/config`
- `/content/config`
- `/content/pages`
- `/content/posts`
### `/config`
Default config for the site, formatted for Hugo.
......@@ -10,15 +17,32 @@ Default config for the site, formatted for Hugo.
- `imaging.toml`: Imaging configuration (for generated images)
- `params.toml`: Theme settings
## `/content/config`
### `/content/config`
A folder containing an empty page which defines the folder as “headless” in its frontmatter. This enables the folder to be used to hold headless content, which we use for the home feature image. (An image with the “home” filename in this folder will be automatically picked up as the homepage’s feature image.)
## `/content/pages`
### `/content/pages`
Default pages to be included with every site to encourage best practices with privacy and RSS feeds. These pages will automatically be added to the footer links.
If the site is multilingual, these pages will need to be added inside an `/english` folder: `/content/english/pages`
We’ll want to add a default page and a default post so that the site isn’t empty when it’s generated. (Issue #1)
\ No newline at end of file
### `/content/posts`
We’ll want to add a default page and a default post so that the site isn’t empty when it’s generated. ([starter-blog-theme issue #30](https://source.small-tech.org/site.js/starters/starter-blog-theme/-/issues/30))
## Requirements
1. [Site.js](https://sitejs.org/#get-started)
2. [Site.js starter blog theme](https://source.small-tech.org/site.js/starters/starter-blog-theme/)
## How to run
0. Download and install [Site.js](https://sitejs.org/#get-started).
1. Create a folder on your computer for the site.
2. Clone or download this `starters-defaults` repository into your new folder.
3. Inside the folder, navigate to the `.hugo/themes/` folder.
4. Clone or download the [`starter-blog-theme`](https://source.small-tech.org/site.js/starters/starter-blog-theme/) repository into the `.hugo/themes/` folder.
5. In your command line interface, navigate to your site folder and run the command, `site`.
Your copy of the site should now be running locally on [https://localhost](https://localhost).
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment