Add some docs for projects.

master
Max Willsey 7 years ago
parent 6a98ae580e
commit 0fbd9b8d11

@ -71,8 +71,26 @@ For full blog posts, use this format:
And concoct a page title for your post. The body of the post goes after the `---` in either case. And concoct a page title for your post. The body of the post goes after the `---` in either case.
You can also customize the icon that is displayed on the news feed. By default it's `newspaper-o`. We use icons from the [FontAwesome][fa] icon set.
[yfm]: http://jekyllrb.com/docs/frontmatter/ [yfm]: http://jekyllrb.com/docs/frontmatter/
[fa]: http://fontawesome.io/icons/
Projects
--------
To create a project, just create a markdown file in the `_projects` folder. Here are the things you can put in the YAML frontmatter:
- `title:` The project title.
- `notitle:` Set this to `true` if you don't want a title displayed on the project card. Optional.
- `description:` The text shown in the project card. It supports markdown.
- `people:` The people working on the project. This is a list of keys from the `_data/people.yml` file.
- `layout: project` This sets the layout of the actual project page. It should be set to `project`.
- `image:` The URL of an image for the project. This is shown on both the project page and the project card. Optional.
- `last-updated:` Date in the format of `YYYY-MM-DD`. The project cards are sorted by this, most recent first.
- `status: inactive` Set this to `inactive` if don't want the project to appear on the front page. Just ignore it otherwise.
- `link:` Set this to an external URL if this project has a page somewhere else on the web. If you don't have a `link:`, then the content of this markdown file (below the YAML frontmatter) will be this project's page.
- `no-link: true` Set this if you just don't want a project page for your project.
Personnel Personnel
--------- ---------

Loading…
Cancel
Save