folio — Jekyll Portfolio Template

SHA-256: 544c5bcacf63bbaa2ee7c58485210e49771d6d71f9f2f7b9375726877c236756

2026-10-13T09:40:59.170Z

<p align="center">
  <img src="assets/favicon.svg" alt="Folio logo" width="96" height="96">
</p>

<h1 align="center">Folio</h1>

A clean, minimal [Jekyll](https://jekyllrb.com/) template for writing and publishing books online.

📖 **[Read the documentation](https://felipejoglar.github.io/folio/)** — built with Folio itself.

<p align="center">
  <img src="assets/img/cover.png" alt="Folio book cover page" width="640">
  <br>
  <em>The Folio landing page with cover, resume bookmark, and start-reading button.</em>
</p>

## Features

- 📖 Chapter-based content using a Jekyll collection
- 🧭 Sidebar navigation with table of contents
- 🎨 Customizable theming and styling
- 🔖 Resume reading where you left off
- 🔗 Social sharing support
- ⚡ Fast, static, and easy to deploy

## Getting started

### Prerequisites

- [Ruby](https://www.ruby-lang.org/) and [Bundler](https://bundler.io/)

### Installation

```bash
bundle install
```

### Run locally

```bash
bundle exec jekyll serve
```

The site will be available at `http://localhost:4000`.

> `baseurl` is left empty in `_config.yml` so local development works at the
> root. The GitHub Pages workflow injects the correct project path (e.g.
> `/folio`) at build time, so deployment still resolves correctly — see the
> deployment chapter for details.

## Writing chapters

Add your chapters as Markdown files in the `_chapters/` directory. Each file
becomes a page in the book. Configure titles, ordering, and metadata via front
matter.

## Configuration

Edit `_config.yml` to set the book title, author, subtitle, language, and other
options.

Set `color_theme` to tint the whole site with a color theme — `default`, `blue`,
`green`, `sepia`, `violet`, `rose`, `teal`, or `crimson` — on top of the
built-in light/dark toggle. Use
`random` to pick a different theme on every page load. See the
[theming documentation](https://felipejoglar.github.io/folio/theming/) for details.

## Project structure

```
.
├── _chapters/    # Book chapters (Markdown)
├── _includes/    # Reusable HTML partials
├── _layouts/     # Page layouts
├── assets/       # CSS and JS
├── index.html    # Landing page
└── _config.yml   # Site configuration
```

## License

Released under the [MIT License](LICENSE).