We decide to do a simple jekyll site so everybody can contribute, coders and non-coders. Here Content is the king, so the most important thing is that we get the most valuable information about the Fellow Cities that will help us before and during the fellowship year. For us, as fellows is important to know very well about the cities we"ll have the opportunity to serve as well as the cities that other fellows friends are working with so we can work together to get the most useful apps for the people of this cities this year.
If you don"t have jekyll installed, check out the installation docs.
Additionally, if you are running an older version of OSX, it"s possible that you won"t be able to build the site properly because your version of Ruby is too old. If this happens, you can try to homebrew the new version of Ruby, and set your PATH to prioritize that one. (export PATH=export PATH=/usr/local/bin:$PATH
)
- Fork the repo
- Download to your local machine
- Open de terminal
cd /path/to/repo
- run:
jekyll serve
- Open your web browser
- In the url bar enter
localhost:4000
- And "Voilà!"
Editing
- Open your text editor of preference.
- Look in the root of the project for the directories named after the cities.
- You will find a markdown doc called index.md inside.
- Edit the index.md file. a. If you are adding photos, links to data resources, or links to news pieces, you can edit the YAML on the top of the page. Just keep the formatting the same, and they will automatically appear properly.* b. If you are adding more detailed information, just edit the page directly with Markdown syntax.
- And make a pull request in github repo page.
Here some very good resources related to this project.
- Note on YAML: If your news article has quotes in quotes in quotes (see Indianapolis for an example), you"ll have to give YAML the unicode character for a double quote, which is \u0022. Please refer to the Indy page for an example.