https://github.com/cecilapp/theme-docs
Documentation theme for Cecil.
https://github.com/cecilapp/theme-docs
cecil cecil-theme tailwindcss theme
Last synced: 3 months ago
JSON representation
Documentation theme for Cecil.
- Host: GitHub
- URL: https://github.com/cecilapp/theme-docs
- Owner: Cecilapp
- License: mit
- Created: 2024-01-02T10:26:21.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-16T12:07:19.000Z (about 2 years ago)
- Last Synced: 2024-05-23T07:26:50.980Z (about 2 years ago)
- Topics: cecil, cecil-theme, tailwindcss, theme
- Language: CSS
- Homepage: https://statidocs.cecil.app
- Size: 400 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# _Docs_ theme
Documentation theme for [Cecil](https://cecil.app), powered by [Tailwind CSS](https://tailwindcss.com) and [Algolia DocSearch](https://docsearch.algolia.com).
## Features
- Auto-generated navigation sidebar
- [Algolia DocSearch](https://docsearch.algolia.com) integration
- Ready for content localization (l10n)
- Templates internationalization (i18n)
- Mobile friendly
- Dark theme
- Blog posts templates
## Installation
```bash
composer require cecil/theme-docs
```
> Or [download the latest archive](https://github.com/Cecilapp/theme-docs/releases/latest/) and uncompress its content in `themes/docs`.
## Usage
Add `docs` in the `theme` section of the `config.yml`:
```yaml
theme:
- docs
```
### Configuration
```yaml
sidebar:
-
-
footer: Copyright © %author%
github:
repo: https://github.com//
branch:
docsearch:
enabled: true|false
appId:
indexName:
apiKey:
debug: false|true
```
## Development
### Install deps
```bash
npm install
```
### Rebuild CSS
```bash
npm run css:build
```
## License
_Docs_ theme is a free software distributed under the terms of the MIT license.
© [Arnaud Ligny](https://arnaudligny.fr)