Skip to content

Commit d51aba9

Browse files
authored
Merge pull request #14 from indigotree/documentation
Documentation
2 parents 0ceac59 + e0454a1 commit d51aba9

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

+14
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ The [Hugo](https://gohugo.io/) boilerplate we use for our projects.
88

99
**Disclaimer** - This boilerplate has been heavily integrated with [Netlify](https://www.netlify.com/), and therefore many features are specific to the Netlify platform and may not work with other hosting providers.
1010

11+
**Disclaimer** - Atlas is a boilerplate (starter kit) for bespoke Hugo projects. It's not a Hugo theme and cannot be placed inside the `/themes` directory. Check the [theme](#themes) docs for more information.
12+
1113
## Features
1214

1315
Atlas provides the following features out of the box:
@@ -19,6 +21,10 @@ Atlas provides the following features out of the box:
1921
* [Better defaults](#security-headers) for configuring HTTPS
2022
* [Better redirects](#redirects) with Netlify instead of `<meta http-equiv="refresh">`
2123

24+
## Prerequisite
25+
26+
Atlas does not include a copy of the `hugo` binary. You will need to [install Hugo](https://gohugo.io/getting-started/installing/) first you can run any of the [commands](#available-commands) mentioned below.
27+
2228
## Getting Started
2329

2430
To get started, you can either clone the repository, or deploy straight to [Netlify](#deploy-to-netlify). Then run the following from the project root:
@@ -91,6 +97,14 @@ If Netlify CMS isn't your thing, you can remove it with:
9197
npm run cms:delete
9298
```
9399

100+
## Themes
101+
102+
Atlas is a boilerplate (starter kit) designed to aid bespoke Hugo development. Using existing themes with Atlas is possible, but unsupported.
103+
104+
Atlas files will take priority over your theme due to the order Hugo looks for files. For this reason, you will have to remove most of the files inside `/layouts` with the exception of `_headers`, `_redirects` and `robots.txt`.
105+
106+
If you wish the develop your site as a theme inside Atlas, you can copy `/layouts` into your theme and update the references within the `gulpfile.babel.js`.
107+
94108
## Deploy to Netlify
95109

96110
You can deploy directly to Netlify using this button:

0 commit comments

Comments
 (0)