Guide

This guide explains how to configure and write content for your LeFolio Academic site. Everything lives in the Content/ folder.

Configuration

Edit Content/config.yaml to control site metadata, the homepage, author profile, and navigation.

Site settings

Key	Purpose
site.title	Browser tab title and sidebar footer
site.description	SEO description
site.url	Canonical site URL
site.basePath	GitHub Pages subpath (e.g. /lefolio-academic)
analytics.google	GA4 measurement ID (G-…); omitted = no analytics

For a user site at username.github.io, set basePath: "". For a project site at username.github.io/repo-name, set basePath: "/repo-name".

Homepage

home points to any markdown file, relative to Content/:

Top-level files like About.md or CV.md can live directly in Content/.

Author profile

The sidebar shows avatar, bio, location, employer, and links. Supported link keys include email, orcid, googlescholar, github, and linkedin.

Place images in Content/Assets/ and reference them as Assets/filename.jpg.

Content structure

Content/
├── config.yaml
├── About.md              # can be used as homepage
├── CV.md                 # top-level page
├── Assets/
│   └── profile.jpg
├── Pages/
│   └── Guide.md
├── Projects/
│   └── My Project.md
└── Publications/
    └── paper.md

Each folder under Content/ (except Assets/) is a section. Each .md file becomes a page.

Section index note

If a section folder contains a note with the same name as the folder (e.g. Publications/Publications.md), that note is not listed as a page. Instead:

• Its body is shown above the section listing
• Its frontmatter configures the listing

For publication_thumbnail, each page can set:

thumbnail can be a filename, relative path, or wikilink to an image under Content/.

For grid (useful for projects), each card shows thumbnail, title, and subtitle:

If thumbnail is omitted, the first image embed in the note is used, otherwise the first image in the same folder (preferring filenames that start with 0_). sort: date also honors start_date / end_date.

Page frontmatter

Optional YAML at the top of any page:

Field	Purpose
title	Display title (defaults to filename)
date	Sort key for listings
order	Manual sort order (lower = first)
permalink	URL slug override
published	Set to false to keep the note in the vault but omit it from the site

A file Publications/My Paper.md with permalink: my-paper is served at /Publications/my-paper/.

Navigation

The top navbar is driven by navigation in config.yaml. Each item can link to a section or a specific page.

Auto-detection

When you list a name only, the site resolves it automatically:

• Section folder exists → links to the section index (e.g. Projects → /Projects/)
• Top-level .md file exists → links to that page (e.g. CV → /CV/ from CV.md)

Explicit page path

Point a nav label at any markdown file:

Map syntax

You can also use a YAML map:

Markdown

LeFolio supports standard Markdown, GitHub Flavored Markdown (GFM), and Obsidian-style syntax.

Headings, lists, and tables

Wikilinks

Link to other pages using Obsidian-style double brackets:

Image embeds

Embed images from anywhere under Content/:

Parameters after | are optional and can appear in any order:

Parameter	Effect
200 (number)	Width in pixels
left, right, center	Alignment
wrap	Float beside text; text wraps around the image

wrap without an alignment defaults to right.

Math

Inline math uses single dollar signs:

Block math uses double dollar signs on their own lines:

Math is rendered with KaTeX.

Mermaid diagrams

Use a fenced mermaid code block:

Plotly charts

Use a fenced plotly code block with JSON:

The JSON follows the standard Plotly chart schema. You can include data, layout, and config keys.

Development

Edit files in Content/ — changes sync automatically during development.