https://github.com/singularityhub/singularityhub-docs

improved documentation for Singularity Hub
https://github.com/singularityhub/singularityhub-docs

containers documentation mkdocs-jekyll singularity singularity-hub

Last synced: 26 days ago
JSON representation

improved documentation for Singularity Hub

• Host: GitHub
• URL: https://github.com/singularityhub/singularityhub-docs
• Owner: singularityhub
• License: mit
• Created: 2019-07-13T21:17:51.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-04-26T04:17:29.000Z (over 3 years ago)
• Last Synced: 2024-05-01T21:40:04.103Z (8 months ago)
• Topics: containers, documentation, mkdocs-jekyll, singularity, singularity-hub
• Language: CSS
• Homepage: https://singularityhub.github.io/singularityhub-docs
• Size: 12.1 MB
• Stars: 0
• Watchers: 4
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MkDocs Jekyll Theme

[![CircleCI](https://circleci.com/gh/vsoch/mkdocs-jekyll/tree/master.svg?style=svg)](https://circleci.com/gh/vsoch/mkdocs-jekyll/tree/master)

![assets/img/mkdocs-jekyll.png](assets/img/mkdocs-jekyll.png)

This is a [starter template](https://vsoch.github.com/mkdocs-jekyll/) for a mkdocs jekyll theme, based on these two

previous arts:

 - [alexcarpenter/material-jekyll-theme](http://alexcarpenter.github.io/material-jekyll-theme)

 - [squidfunk/mkdocs-material](https://github.com/squidfunk/mkdocs-material)

## Usage

### 1. Get the code

You can clone the repository right to where you want to host the docs:

```bash

git clone https://github.com/vsoch/mkdocs-jekyll.git docs

cd docs

```

### 2. Customize

To edit configuration values, customize the [_config.yml](_config.yml).

To add pages, write them into the [pages](pages) folder. 

You define urls based on the `permalink` attribute in your pages,

and then add them to the navigation by adding to the content of [_data/toc.myl](_data/toc.yml).

### 3. Options

Most of the configuration values in the [_config.yml](_config.yml) are self explanatory,

and for more details, see the [about page](https://vsoch.github.io/mkdocs-jekyll/about/)

rendered on the site.

### 4. Serve

Depending on how you installed jekyll:

```bash

jekyll serve

# or

bundle exec jekyll serve

```