Pour tout problème contactez-nous par mail : support@froggit.fr | La FAQ :grey_question: | Rejoignez-nous sur le Chat :speech_balloon:

Skip to content
Snippets Groups Projects
Commit edf36c0a authored by Christophe Chaudier's avatar Christophe Chaudier :rocket:
Browse files

Merge branch '1-init-site-with-staticast' into 'main'

Resolve "init site with staticast"

Closes #2 and #1

See merge request !1
parents 76489adf 0c850df4
No related branches found
No related tags found
1 merge request!1Resolve "init site with staticast"
Pipeline #10476 passed
Showing with 1862 additions and 49 deletions
# editorconfig.org
root = true
[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
[*.md]
trim_trailing_whitespace = false
[*.twig]
insert_final_newline = false
# Auto detect text files and perform LF normalization
* text=auto
.site/
.cecil/
.cache/
vendor/
_site/
themes/
node_modules/
image: alpine:latest
image: cimg/php:8.2
cache:
paths:
- composer-cache/
- vendor/
- .cache/
variables:
CECIL_BASEURL: https://poc-staticast.froggit.page/
before_script:
- |
echo "Downloading Cecil..."
if [[ -z "$CECIL_VERSION" ]]; then
curl -sSOL https://cecil.app/cecil.phar
else
curl -sSOL https://cecil.app/download/$CECIL_VERSION/cecil.phar
fi
- php cecil.phar --version
- COMPOSER_CACHE_DIR=composer-cache composer install --prefer-dist --no-dev --no-progress --no-interaction
test:
stage: test
tags:
- cache
script:
- php cecil.phar build --verbose --output=test
artifacts:
paths:
- test
rules:
- if: $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH
pages:
stage: deploy
tags:
- cache
script:
- echo 'Nothing to do...'
- php cecil.phar build --output=public
artifacts:
paths:
- public
- public
rules:
- if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
LICENSE 0 → 100644
MIT License
Copyright (c) Arnaud Ligny
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
![Build Status](https://gitlab.com/pages/plain-html/badges/master/build.svg)
# Staticast
---
_Staticast_ is a ready to use Progressive Web App to publish your podcast, with a RSS feed ready for syndication platforms, and a user friendly CMS.
Example plain HTML site using GitLab Pages.
[![Staticast preview](https://user-images.githubusercontent.com/80580/150656228-4e7b08e2-b3f3-4c54-9bb1-818260e88e19.png)](https://staticast.cecil.app)
Learn more about GitLab Pages at https://pages.gitlab.io and the official
documentation https://docs.gitlab.com/ce/user/project/pages/.
## Installation
---
### Manually
_Staticast_ is a website generated by [Cecil](https://cecil.app), so you need to download and run Cecil to build your website, then you can publish it where you want.
1. Be sure PHP (>=7.4) is available on your OS
2. [Download _Staticast_](https://github.com/Cecilapp/staticast/archive/master.zip) and install themes with `composer install`
3. [Download `cecil.phar`](https://github.com/Cecilapp/Cecil/releases/latest/download/cecil.phar) and move it to the root of _Staticast_
### Automatically
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
Use the button to get your own copy of the repository on [Netlify](https://www.netlify.com).
- [GitLab CI](#gitlab-ci)
- [GitLab User or Group Pages](#gitlab-user-or-group-pages)
- [Did you fork this project?](#did-you-fork-this-project)
- [Troubleshooting](#troubleshooting)
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/Cecilapp/staticast&stack=cms)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
This will setup everything needed for running your website, with a CMS:
## GitLab CI
- A new repository in your GitHub account
- Continuous Deployment to Netlify's CDN
- Control users and access with Netlify Identity
- Manage content with Netlify CMS
This project's static Pages are built by [GitLab CI][ci], following the steps
defined in [`.gitlab-ci.yml`](.gitlab-ci.yml):
## Usage
### Create a new episode
1. Add the MP3 file in `assets` directory
2. Create a new Markdown file in `pages/episodes`
Example (`1.md`):
```yaml
---
title: "Episode #1"
episode:
file: episode-1.mp3
---
Short description of the episode.
<!-- break -->
Notes of the episode.
```
image: alpine:latest
pages:
stage: deploy
script:
- echo 'Nothing to do...'
artifacts:
paths:
- public
only:
- master
Refer to _[Podcast component theme](https://github.com/Cecilapp/theme-podcast#usage)_ for advanced options.
### Preview
Run the following command:
```bash
php cecil.phar serve --open
```
The above example expects to put all your HTML files in the `public/` directory.
### Publish
## GitLab User or Group Pages
1. Run `php cecil.phar build`
2. Copy `_site` folder to your web server
To use this project as your user/group website, you will need one additional
step: just rename your project to `namespace.gitlab.io`, where `namespace` is
your `username` or `groupname`. This can be done by navigating to your
project's **Settings**.
### Configuration
Read more about [user/group Pages][userpages] and [project Pages][projpages].
Edit the [`config.yml`](https://github.com/Cecilapp/staticast/blob/master/config.yml) file, and more precisely the `podcast` section.
## Did you fork this project?
> For details, please refer to the [Cecil documentation](https://cecil.app/documentation/configuration/).
If you forked this project for your own use, please go to your project's
**Settings** and remove the forking relationship, which won't be necessary
unless you want to contribute back to the upstream project.
## Development
_Staticast_ use [Tailwind CSS](https://tailwindcss.com) so you can customize the stylesheet with the following files:
- Configuration: [`tailwind.config.js`](tailwind.config.js)
- CSS: [`assets/tailwind.css`](assets/tailwind.css)
```bash
# install
composer install
npm install
# build CSS
npx tailwindcss -i ./assets/tailwind.css -o ./assets/styles.css --watch
# serve
php cecil.phar serve -v --config=config/dev.yml
```
## Troubleshooting
## License
1. CSS is missing! That means that you have wrongly set up the CSS URL in your
HTML files. Have a look at the [index.html] for an example.
_Staticast_ is a free software distributed under the terms of the MIT license.
[ci]: https://about.gitlab.com/gitlab-ci/
[index.html]: https://gitlab.com/pages/plain-html/blob/master/public/index.html
[userpages]: https://docs.gitlab.com/ce/user/project/pages/introduction.html#user-or-group-pages
[projpages]: https://docs.gitlab.com/ce/user/project/pages/introduction.html#project-pages
© [Arnaud Ligny](https://arnaudligny.fr)
File added
assets/favicon.png

3.61 KiB

assets/icons/apple.png

14.6 KiB

assets/icons/google.png

5.99 KiB

assets/icons/rss.png

6.64 KiB

assets/icons/spotify.png

8.73 KiB

assets/manifest/icon-192x192.png

2.93 KiB

assets/manifest/icon-512x512.png

9.32 KiB

assets/my_cover.png

1.83 MiB

This diff is collapsed.
@tailwind base;
@tailwind components;
@tailwind utilities;
@layer base {
html {
font-size: 18px
}
a {
@apply text-primary;
}
audio {
width: 100%;
margin: 1rem 0 1rem 0;
}
}
assets/twitter-card.png

11.1 KiB

File added
{
"name": "cecil/staticast",
"description": "The easiest way to diffuse your podcast",
"license": "MIT",
"type": "project",
"authors": [
{
"name": "Arnaud Ligny",
"email": "arnaud@ligny.fr",
"homepage": "https://arnaudligny.fr",
"role": "Developer"
}
],
"require": {
"cecil/theme-podcast": "^1.15",
"cecil/theme-pwa": "^1.13",
"cecil/theme-netlify": "^1.3",
"cecil/theme-netlifycms": "^1.7"
},
"config": {
"allow-plugins": {
"cecil/theme-installer": true
}
}
}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment