You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
added a usage section to the readme describing that an index page is not neccessary, and will overwrite the about page if it exists. Also added a link to the MIT license following the default jekyll theme readme.
Copy file name to clipboardExpand all lines: README.md
+6-2
Original file line number
Diff line number
Diff line change
@@ -39,13 +39,17 @@ By default, the script uses the `master` branch for the source code and deploys
39
39
The optional flag `--user` tells it to deploy to `master` and use `source` for the source code instead.
40
40
Using `master` for deployment is a convention for [user and organization pages](https://help.github.com/articles/user-organization-and-project-pages/).
41
41
42
-
**Note:** when deploying your user or organization page, make the `_config.yml` has `url` and `baseurl` fields as follows.
42
+
**Note:** when deploying your user or organization page, make sure the `_config.yml` has `url` and `baseurl` fields as follows.
43
43
44
44
```
45
45
url: # should be empty
46
46
baseurl: # should be empty
47
47
```
48
48
49
+
### Usage ###
50
+
51
+
Note that `_pages/about.md` is built to index.html in the published site. There is therefore no need to have a separate index page for the project. If an index page does exist in the root directory then this will prevent `_pages/about.md` from being added to the built site.
52
+
49
53
## Features
50
54
51
55
#### Ergonomic Publications
@@ -100,4 +104,4 @@ Style improvements and bug fixes are especially welcome.
100
104
101
105
## License
102
106
103
-
MIT
107
+
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
0 commit comments