Cecil requires PHP 8.1+.

Installation

Download the Phar and create a new site:

curl -LO https://cecil.app/cecil.phar
php cecil.phar new:site

Enable the theme

composer require cecil/theme-aube

Then add aube to the theme section of your configuration:

theme:
  - aube

Next steps

Read the configuration page to customize colors, logo and footer.

aube:
  colors:
    primary: '#d43900'

Logo and font

aube:
  logo: images/logo.svg
  font:
    family: Inter

Color mode

aube:
  color_mode:
    enabled: true
    default: auto

Footer

aube:
  footer:
    text: 'Code released under the MIT license.'
    columns:
      - title: Links
        links:
          - { name: Docs, url: docs }

Table of content:

[toc]

Inline style

Text can be bold, italic, or strikethrough.

Text can be **bold**, _italic_, or ~~strikethrough~~.

You can link to a page or to another page.

You can [link to a page](/about.md) or [to another page](page:index).

You can highlight inline code with backticks.

You can highlight `inline code` with backticks.

How to structure page

Cecil automatically use the page file name as title, but you can also define title and other variables in the front matter.

You can structure content using a heading. Headings in Markdown are indicated by a number of # at the start of the line.

---
title: Page title
description: Page short description.
---

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

## Heading

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Image

Images use Cecil’s built-in optimized asset support.

![Cecil favicon](/favicon.png "Cecil favicon")

Cecil search images in assets/ and static/ folders, but relative path is also supported:

![Cecil favicon](../assets/favicon.png "Cecil favicon")

List

• Unordered list
• Unordered list
• Unordered list

1. Ordered list
2. Ordered list
3. Ordered list

• Level 1
  • Level 2
  • Level 2
    • Level 3
    • Level 3

Blockquote

This is a blockquote, which is commonly used when quoting another person or document.

Blockquotes are indicated by a > at the start of each line.

> This is a blockquote, which is commonly used when quoting another person or document.
>
> Blockquotes are indicated by a `>` at the start of each line.

Code block

A code block is indicated by a block with three backticks ``` at the start and end. You can indicate the programming language being used after the opening backticks.

// PHP code
$config = [
    'title'   => "My website",
    'baseurl' => 'http://localhost:8000/',
];

Builder::create($config)->build();

```php
// PHP code
$config = [
    'title'   => "My website",
    'baseurl' => 'http://localhost:8000/',
];

Builder::create($config)->build();
```

There is a horizontal rule below this

Definition list

First Term

This is the definition of the first term.

Second Term

This is one definition of the second term.

This is another definition of the second term.

Table

Notes

:::info|tip|important|warning|caution
Note here.
:::