GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GitHub - code-openness/code-openness.github.io: Jekyll documentation repository for the code-openness organisation:

BranchesTags
Open more actions menu

Latest commit

 

History

153 Commits
153 Commits

Folders and files

NameName
Last commit message
Last commit date
assets/js
assets/js
 
 
teamOne
teamOne
 
 
teamThree
teamThree
 
 
teamTwo
teamTwo
 
 
.gitignore
.gitignore
 
 
404.html
404.html
 
 
Gemfile
Gemfile
 
 
Gemfile.lock
Gemfile.lock
 
 
README.md
README.md
 
 
_config.yml
_config.yml
 
 
grafik.png
grafik.png
 
 
index.md
index.md
 
 
teamOne.md
teamOne.md
 
 
teamThree.md
teamThree.md
 
 
teamTwo.md
teamTwo.md
 
 

Repository files navigation

code-openness.github.io

Installing ruby and Jekyll:

$ ruby --version
$ gem install bundler

followed by:

$ bundle install

This installs everything defined in the Gemfile and _config.yml.

for further instalation help check: GitHub

See edited jekyll site locally using:

$ bundle exec jekyll serve
$ bundle exec jekyll serve
> Configuration file: /Users/octocat/my-site/_config.yml
>            Source: /Users/octocat/my-site
>       Destination: /Users/octocat/my-site/_site
> Incremental build: disabled. Enable with --incremental
>      Generating...
>                    done in 0.309 seconds.
> Auto-regeneration: enabled for '/Users/octocat/my-site'
> Configuration file: /Users/octocat/my-site/_config.yml
>    Server address: http://127.0.0.1:4000/
>  Server running... press ctrl-c to stop.

Used theme:

We are using the just-the-docs theme from https://github.com/pmarsceill/just-the-docs

specific installation:

$ gem install just-the-docs

Page Navigation:

we are currentlly using the navigation bar formating described in just-the-docs documentation At the beginning of each Markdown file there should be a, heading. Currently each team has an overall team link (parent file) and should add all other documentation files into their respective folder ex. teamThree. The parent file (ex. teamOne.md) should contain the following heading:

---
layout: default
title: 'Team 1: Data Context' 
nav_order: 1
has_children: true
permalink: /teamOne
---

nav_order defines at which position in the nav-bar it will be shown, team one should be in position 1, team two in position 2 etc. has_childrenis set to true, to indicate that there are sub files, which will need to be displayed as sub-categories. permalinkgives the link to the folder in which the documentation files of each team are to be found

In the child files, the following heading should be put at the beginning of each file:

---
layout: default
title: Example
parent: 'Team 1: Data Context' 
nav_order: 1
---

Here it is important to note that the parent tag needs to contain the title of the parent page/file, not the file name!! In addition the nav_order should be adjusted to order the child pages, eg. Background should be in position 1, Motivation in 2 etc.

About

Jekyll documentation repository for the code-openness organisation:

code-openness.github.io/

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

1 watching

Forks

2 forks
Report repository

Releases

Packages

Used by

Contributors

Languages

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.