Skip to content

Commit

Permalink
Added info about adding content to README
Browse files Browse the repository at this point in the history
  • Loading branch information
nabaco committed May 3, 2020
1 parent 60a2fa0 commit 1eb6f2e
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,20 @@ documentation.
## Quick Start to see the website locally

- Install Ruby
- `$ gem install bundler jekyll`
- `$ cd vegastrike.github.io`
- `$ bundle install`
- `$ bundle exec jekyll serve`
- Exec:
```sh
$ gem install bundler jekyll
$ cd vegastrike.github.io
$ bundle install
$ bundle exec jekyll serve
```
- Browse to http://localhost:4000

## Notes

- Try to keep the repo as small as possible. No need to load huge files, unless they are going to be embedded directly into the website.
- To add a new link in the navigation bar, go to `_data/nav.yml`
- To change the theme, change the value of `bootwatch` in `_config.yml`
- Load media to ./assets/
- Try to keep the repo as small as possible. No need to load huge files, unless they are going to be
embedded directly into the website.
- To make a new announcement, add a file in `./_posts/`. E.g. `YYYY-MM-DD-name-of-post.md`. Added
to the top of the file the standard header as in all other posts.
- Load media to `./assets/`

0 comments on commit 1eb6f2e

Please sign in to comment.