https://github.com/cecilapp/statidocs
Build a documentation website quickly.
https://github.com/cecilapp/statidocs
cecil cecil-starter documentation static-site
Last synced: about 1 year ago
JSON representation
Build a documentation website quickly.
- Host: GitHub
- URL: https://github.com/cecilapp/statidocs
- Owner: Cecilapp
- License: mit
- Created: 2023-05-15T22:34:47.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-11T13:32:56.000Z (over 2 years ago)
- Last Synced: 2024-04-14T01:06:00.750Z (about 2 years ago)
- Topics: cecil, cecil-starter, documentation, static-site
- Language: JavaScript
- Homepage: https://statidocs.cecil.app
- Size: 1.16 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Statidocs
Statidocs is a documentation starter site, built on top of [Cecil](https://cecil.app) and the [Docs theme](https://github.com/Cecilapp/theme-docs).
[](https://statidocs.cecil.app)
> [!IMPORTANT]
> Statidocs is still in development. If something that’s not working, please [open an issue on GitHub](https://github.com/Cecilapp/statidocs/issues/new/choose).
## Install
The easiest way to create a new Statidocs project is using [Composer](https://getcomposer.org):
```bash
composer create-project cecil/statidocs --ask
```
[](https://packagist.org/packages/cecil/statidocs)
## Demo
- Hosted by GitHub Pages:
- Hosted by Vercel:
## Usage
Build & preview:
```bash
php cecil.phar serve
```
Read the [documentation](https://statidocs.cecil.app).
### Update themes
Statidocs is depending of Cecil's themes [Docs](https://github.com/Cecilapp/theme-docs) and [PWA](https://github.com/Cecilapp/theme-pwa).
Use Composer to update them:
```bash
composer update
```
### Configuration
Open and edit the [`cecil.yml`](cecil.yml) file.
### Customize colors
Checks the [`tailwind.config.js`](tailwind.config.js) file, then rebuild the CSS file:
```bash
npm install
npx tailwindcss -i ./themes/docs/tailwind.css -o ./assets/styles.css
```
## Publish
```bash
php cecil.phar build
```
Then copy content of `_site` to your web server.