florent/pages
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

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.

Browse Source
This commit is contained in:
Sam Fearn 2018-06-08 17:20:30 +01:00
parent d05f8a3767
commit d263296c8a
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -39,13 +39,17 @@ By default, the script uses the `master` branch for the source code and deploys
The optional flag `--user` tells it to deploy to `master` and use `source` for the source code instead. The optional flag `--user` tells it to deploy to `master` and use `source` for the source code instead.
Using `master` for deployment is a convention for [user and organization pages](https://help.github.com/articles/user-organization-and-project-pages/). Using `master` for deployment is a convention for [user and organization pages](https://help.github.com/articles/user-organization-and-project-pages/).
**Note:** when deploying your user or organization page, make the `_config.yml` has `url` and `baseurl` fields as follows. **Note:** when deploying your user or organization page, make sure the `_config.yml` has `url` and `baseurl` fields as follows.
``` ```
url: # should be empty url: # should be empty
baseurl: # should be empty baseurl: # should be empty
``` ```
### Usage ###
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.
## Features ## Features
#### Ergonomic Publications #### Ergonomic Publications
@ -100,4 +104,4 @@ Style improvements and bug fixes are especially welcome.
## License ## License
MIT The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).