Skip to content

Latest commit

 

History

History
105 lines (83 loc) · 2.33 KB

README.md

File metadata and controls

105 lines (83 loc) · 2.33 KB
Raw

Documentation

Documentation of CuboHub

Install

  1. Go https://github.com/apps/cubohub

  2. Click in "Install" image

  3. Select the user/org image

  4. Click in "Install" image

  5. Create a new README.md

  6. Create a new file .cubohub.yml

Example File

title: MyRepo
template: Elate
readme: README.md
language: HTML
description: MY DESCRIPTION
links:
  Github: https://github.com/MyUser/MyRepo

image

  1. Um index.html foi criado com seu site

More Details

  1. Example File: CuboHub.yml
title: Elate Theme
template: Elate
readme: README.md
language: HTML5
description: Elate Theme for CuboHub
links:
  CuboHub: https://CuboHub.github.io
  Github: https://github.com/CuboHub/Elate-theme
  1. Valid configuration files
Path/File
.cubohub.yml
.cuboHub.yml
.CuboHub.yml
cubohub.yml
cuboHub.yml
CuboHub.yml
.github/cubohub.yml
.github/cuboHub.yml
.github/CuboHub.yml
  1. Settings

NOTE: template or template_raw is required

Parameter About Default
title Page title repo.name
repo None of the repository repo.name
full_name Full name, e.g CuboHub/Documentation repo.full_name
template Name of template null
template_raw URL of template null
iframe Path/File of code in HTML if True: "iframe.html"
readme Path/File of README.md if True: "README.md"
description Project description repo.description
language Project language repo.language
config.size Project size repo.size
seo Sub-parameter, see 3. SEO null
gitauthor Sub-parameter, see 4. Gitauthor null
branch Commiter branch "master"
cmessage Commiter message "Update GitHub Page: {DateNow}"
  1. SEO
Parameter
title
site_name
url
author
description
keywords
image
twitter_card
  1. Gitauthor
Parameter
name
email