Skip to content

Commit

Permalink
add doc
Browse files Browse the repository at this point in the history
  • Loading branch information
julienj committed Apr 2, 2024
1 parent 68dae1e commit 059935f
Show file tree
Hide file tree
Showing 54 changed files with 4,852 additions and 1 deletion.
46 changes: 46 additions & 0 deletions .github/workflows/doc.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Build and deploy to GitHub Pages
on:
push:
branches: [main]
workflow_dispatch: # run manually

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout source
uses: actions/checkout@v4

- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: '8.1'
extensions: fileinfo, gd, mbstring

- name: Build site
uses: Cecilapp/Cecil-Action@v3

- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
version: '8.9.1'
args: 'doc -v'
deploy:
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v3
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,6 @@ build
test.yml
.php-cs-fixer.cache
.phpunit.cache
doc/.cache
doc/.cecil
doc/_site
6 changes: 5 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ help: ## Outputs this help screen
@grep -E '(^[a-zA-Z0-9_-]+:.*?##.*$$)|(^##)' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}{printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}' | sed -e 's/\[32m##/[33m/'

## —— Docker 🐳 ————————————————————————————————————————————————————————————————
build: ## Builds the Docker images
docker-build: ## Builds the Docker images
@$(DOCKER_COMP) build --pull --no-cache

logs: ## Show live logs
Expand All @@ -29,6 +29,10 @@ php: ## Connect to the PHP FPM container
install: ## Install project
@$(PHP_CONT) composer install

## —— Doc 📖 ————————————————————————————————————————————————————————————————————
doc-serve: ## Serve doc website
cecil serve doc

## —— CI ✨ ————————————————————————————————————————————————————————————————————
ci: cs phpstan rector test ## Run all all checks

Expand Down
Binary file added doc/assets/404.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 44 additions & 0 deletions doc/assets/app.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
// ------------------ //
// SETTINGS
// ------------------ //
@import
"scss/01_settings/settings.breakpoints",
"scss/01_settings/settings.media-queries",
"scss/01_settings/settings.hover",
"scss/01_settings/settings.fonts",
"scss/01_settings/settings.colors",
"scss/01_settings/settings.variables";

// ------------------ //
// GENERICS
// ------------------ //
@import
"scss/02_generics/generics.reset";

// ------------------ //
// GENERICS
// ------------------ //
@import
"scss/03_elements/elements.page";

// ------------------ //
// OBJECTS
// ------------------ //
@import
"scss/04_objects/objects.container";

// ------------------ //
// COMPONENTS
// ------------------ //
@import
"scss/05_components/components.buttons",
"scss/05_components/components.starting",
"scss/05_components/components.advantages",
"scss/05_components/components.baseline",
"scss/05_components/components.flip-card",
"scss/05_components/components.layout",
"scss/05_components/components.header",
"scss/05_components/components.menu",
"scss/05_components/components.main",
"scss/05_components/components.footer",
"scss/05_components/components.404";
Loading

0 comments on commit 059935f

Please sign in to comment.