Documentation of CuboHub
-
Click in "Install"
-
Select the user/org
-
Click in "Install"
-
Create a new README.md
-
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
- Um index.html foi criado com seu site
- 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- 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 |
- 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}" |
- SEO
| Parameter |
|---|
| title |
| site_name |
| url |
| author |
| description |
| keywords |
| image |
| twitter_card |
- Gitauthor
| Parameter |
|---|
| name |