Documentation

Configuration

 1configuration:
 2  branchesDir: branches #where to render your branches, e.g. accessible by https://domain.tld/repo/branches/
 3  language: en #the <html lang="en"> property
 4  favicon: logo.png #where is your favicon in your git repository
 5  footer: <code>git clone {{repo.cloneUrl}}</code> #footer for all pages
 6  generateGitWorktree: true #generate worktree directory or not
 7  header: <h1>{{repo.name}}</h1> #header for all pages
 8  menu: # define your menu
 9    - display: 🏠 Home
10      link: /
11    - display: 📖 Documentation
12      link: /doc/
13    - display: 🔖 Versions
14      link: /CHANGELOG.html
15    - display: 🐞 Issues
16      link: /boards/issues.html
17    - display: 🚀 Code
18      link: /worktree/
19    - display: ☕ Blog
20      link: /blog/
21    - display: 🗨 Contact
22      link: /contact.html
23  meta: # define metadata for all pages
24    description: GitRoot is a small yet powerfull git forge.
25    fediverse:creator: "@forge@gitroot.dev"
26    og:description: GitRoot is a small yet powerfull git forge.
27    og:title: GitRoot
28  style: simple.min.css # style css for all pages, simple.min.css is embeded but you put a path to your personal css in your git repository
29  layout: #define your own layouts
30    - glob: issues/**/*.md #evey markdown in issues directory will use this layout instead of the default one embeded by apex
31      path: layouts/issues.html #if this path don't exist in git, apex will add default one there, so you have an example up-to-date

Layout variables

Forge

• forge.domain what is your domain (e.g. domain.com)
• forge.externalHttpAddr how to access with web (e.g. https://domain.com)
• forge.externalSshAddr how to clone (e.g. ssh://domain.com/)

Repo

• repo.name repo name (e.g. repo1)
• repo.url full web url (e.g. https://domain.com/repo1)
• repo.cloneUrl how to clone you rrepo (e.g. ssh://domain.com/repo1/)

Apex

• repo.favicon your favicon to add in meta of pages in your git repo (e.g. logo.png)
• repo.faviconType the favicon type mime (e.g. image/png)
• repo.css your css to add in meta of pages in your git repo (e.g. css/default.css)

Page

All variables from front-matter of *.md files are accessibles in layout.

If you add:

1---
2var1: res
3---
4
5# Title

Then a {{var1}} in a lyout will be rendered has res.