README

Statidocs is a documentation starter site, built on top of Cecil and the Docs theme.

Important

Statidocs is still in development. If something that’s not working, please open an issue on GitHub.

Install

The easiest way to create a new Statidocs project is using Composer:

composer create-project cecil/statidocs --ask

Demo

Hosted by GitHub Pages: https://cecilapp.github.io/statidocs/
Hosted by Vercel: https://statidocs.vercel.app

Usage

Build & preview:

php cecil.phar serve

Read the documentation.

Update themes

Statidocs is depending of Cecil's themes Docs, FlexSearch, PWA, Redirects and Headers.

Use Composer to update them:

composer update

Configuration

Open and edit the cecil.yml file.

Search

The search is provided by the FlexSearch theme, enabled by default: the index is generated at build time, without any external service.

See the FlexSearch theme configuration to customize indexed sections and search options.

Use Algolia DocSearch instead

You can use Algolia DocSearch instead, with the DocSearch theme:

Install the theme:
```
composer require cecil/theme-docsearch
```

Replace flexsearch by docsearch in the theme section of the cecil.yml file, and add your Algolia credentials:

theme:
  - docs
  - docsearch
  - pwa
  - redirects
  - headers
docsearch:
  appId: <YOUR_APP_ID>
  apiKey: <YOUR_SEARCH_API_KEY> # search-only API key
  indexName: <YOUR_INDEX_NAME>

Optionally, uninstall the FlexSearch theme:
```
composer remove cecil/theme-flexsearch
```

Note

DocSearch requires an Algolia index of your website: apply to the DocSearch program or run your own crawler.
See the DocSearch theme configuration for other options.

Publish

php cecil.phar build

Then copy content of _site to your web server.

cecil / statidocs

Package info

Security

Fund package maintenance!

Statistics