cecil / statidocs
Create and manage an effective documentation.
Fund package maintenance!
ArnaudLigny
Open Collective
Installs: 120
Dependents: 0
Suggesters: 0
Security: 0
Stars: 7
Watchers: 1
Forks: 0
Open Issues: 0
Language:JavaScript
Type:project
Requires
- cecil/theme-docs: ^2.31
- cecil/theme-pwa: ^2.7
- dev-main
- 2.25.2
- 2.25.1
- 2.25.0
- 2.24.1
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.2
- 2.21.1
- 2.21.0
- 2.20.2
- 2.20.1
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.2
- 2.15.1
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.3
- 2.9.2
- 2.9.1
- 2.9.0
- 2.8.0
- 2.7.5
- 2.7.4
- 2.7.3
- 2.7.2
- 2.7.1
- 2.7.0
- 2.6.1
- 2.6.0
- 2.5.4
- 2.5.3
- 2.5.2
- 2.5.1
- 2.5.0
- 2.4.0
- 2.3.1
- 2.3.0
- 2.2.0
- 2.1.1
- 2.1.0
- 2.0.0
- 1.7.2
- 1.7.1
- 1.7.0
- 1.6.3
- 1.6.2
- 1.6.1
- 1.6.0
- 1.5.1
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.3
- 1.2.2
- 1.2.1
- 1.2.0
- 1.1.0
- 1.0.0
This package is auto-updated.
Last update: 2024-11-02 02:06:06 UTC
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 and PWA.
Use Composer to update them:
composer update
Configuration
Open and edit the cecil.yml file.
Customize colors
Checks the tailwind.config.js file, then rebuild the CSS file:
npm install npx tailwindcss -i ./themes/docs/tailwind.css -o ./assets/styles.css
Publish
php cecil.phar build
Then copy content of _site to your web server.