diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml index 64e0260b..2b33974a 100644 --- a/.github/workflows/website.yml +++ b/.github/workflows/website.yml @@ -31,7 +31,7 @@ jobs: node-version: 18 - name: Build Website - run: "make docs" + run: "make website" - name: Upload artifact uses: actions/upload-pages-artifact@v1 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ce89c33e..f773d30b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,5 +39,6 @@ The sources are available within the `website/docs/` folder. To preview the result, you can run: ``` -make docs-preview +cd website +make start ``` diff --git a/Makefile b/Makefile index 37f796ea..7f33f0ca 100644 --- a/Makefile +++ b/Makefile @@ -14,7 +14,7 @@ INFECTION_FLAGS ?= help: @echo 'Available targets' @echo ' clean Removes temporary build artifacts like' - @echo ' docs Builds the documentation website' + @echo ' website Builds the documentation website' @echo ' fix Fixes composer.json and code style' @echo ' fix-prettier Fix code style of non PHP files (not included in "fix" target)' @echo ' test Execute all tests' @@ -90,18 +90,11 @@ fix-prettier: node_modules node_modules: yarn.lock package.json yarn -.PHONY: docs -docs: docs-vendor - cd website && yarn build - -.PHONY: docs-vendor -docs-vendor: - cd website && yarn - -.PHONY: docs-preview -docs-preview: docs-vendor - cd website && yarn start +.PHONY: website +docs: website + cd website && $(MAKE) build .PHONY: clean clean: - rm -rf vendor website/node_modules website/build website/.docusaurus node_modules .phpunit.result.cache .php-cs-fixer.cache build + rm -rf vendor node_modules .phpunit.result.cache .php-cs-fixer.cache build + cd website && $(MAKE) clean diff --git a/README.md b/README.md index c666cd57..68c988e5 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ If you just start using this package, you should install version 2. | Version | PHP Version | | ------- | ----------- | | 2.\* | 7.4 - 8.2 | -| 0.16.\* | 7.0 - 8.0 | +| 0.16.\* | 7.0 - 8.2 | | 0.11.\* | 5.3.0 - 7.4 | ## Documentation diff --git a/couscous.yml b/couscous.yml deleted file mode 100644 index dbde5fa3..00000000 --- a/couscous.yml +++ /dev/null @@ -1,38 +0,0 @@ -include: - - docs - -title: iCalendar Generator for PHP - -template: - directory: website/template - -menu: - - section: Getting Started - items: - getting-started/installation: - text: Installation - url: /getting-started/installation.html - - section: Components - items: - components/event: - text: Event - url: /components/event.html - components/calendar: - text: Calendar - url: /components/calendar.html - components/timezone: - text: Time Zone - url: /components/timezone.html - - section: Advanced - items: - advanced/custom-properties: - text: Custom Properties - url: /advanced/custom-properties.html - advanced/maturity-matrix: - text: Maturity Matrix - url: /advanced/maturity-matrix.html - - section: Legal - items: - imprint: - text: Imprint - url: https://markus.poerschke.nrw/imprint/ diff --git a/website/Makefile b/website/Makefile new file mode 100644 index 00000000..a358125b --- /dev/null +++ b/website/Makefile @@ -0,0 +1,13 @@ +build: node_modules docs/** src/** static/** docusaurus.config.js sidebars.js + yarn build + +node_modules: yarn.lock package.json + yarn + +.PHONY: start +docs-preview: node_modules + yarn start + +.PHONY: clean +clean: + rm -rf node_modules build .docusaurus diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index b2b41173..c70db7cf 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -81,7 +81,7 @@ module.exports = { ], }, ], - copyright: `Copyright (c) 2012-2021 Markus Poerschke, Published under MIT License`, + copyright: `Copyright (c) 2012-2022 Markus Poerschke, Published under MIT License`, }, prism: { additionalLanguages: ["php"],