https://github.com/opendevstack/opendevstack.github.io
Website for the OpenDevStack Project - getting started, troubleshooting guide, etc.
https://github.com/opendevstack/opendevstack.github.io
getting-started github-pages website
Last synced: 9 months ago
JSON representation
Website for the OpenDevStack Project - getting started, troubleshooting guide, etc.
- Host: GitHub
- URL: https://github.com/opendevstack/opendevstack.github.io
- Owner: opendevstack
- License: apache-2.0
- Created: 2018-07-12T13:09:49.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-04-12T05:58:43.000Z (over 2 years ago)
- Last Synced: 2025-01-25T00:20:14.977Z (11 months ago)
- Topics: getting-started, github-pages, website
- Language: SCSS
- Homepage:
- Size: 8.62 MB
- Stars: 1
- Watchers: 36
- Forks: 13
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Static site for OpenDevStack
This project contains the files to generate the OpenDevStack website.
The web site uses the [jekyll](https://jekyllrb.com) static site generator.
You currently need to have a full Ruby installation at your hands.
Serve the site using `bundle exec jekyll s`.
## Layouts
Currently, we support the following layouts
* index
* documentation
### The documentation layout
For any page intended as documentation, specify the documentation layout in the front matter:
```
---
layout: documentation
---
```
This will automatically create a table of contents on the left.
It takes header levels 2 to 4 into account.
## Blog Posts
This follows the Jekyll conventions. Place your blog posts into the `_posts` directory.
It would be possible to create _drafts_ by placing a post (without a date) into the [`_drafts` folder](https://jekyllrb.com/docs/posts/).
But as we require PRs, simply put your proposal into the `_posts` directory.
Blog Posts have a bit of front matter.
We currently support the `author` keyword.
author: richard.attermeyer
The author name, should match the one in your author bio.
## Author Bio
You can (but you need not) add an author bio into the `_authors` folder.
The name of the file should match the auther name you are using in your posts, e.g. `richard.attermeyer`.
The file again consits of some meta data in the front-matter and the content.