simplepie · jtojnar · Oct 23, 2022 · Oct 23, 2022 · Oct 23, 2022 · Oct 24, 2022
diff --git a/.editorconfig b/.editorconfig
@@ -6,15 +6,11 @@ end_of_line = lf
 insert_final_newline = true
 trim_trailing_whitespace = true
 
-[*.{css,js,json,sql}]
+[*.{css,html,js,json,sql}]
 indent_style = tab
 
-[*.html]
-indent_size = 2
-indent_style = space
-
 [*.{markdown,md}]
-indent_size = 4
+indent_size = 2
 indent_style = space
 max_line_length = off
 trim_trailing_whitespace = false

diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml
@@ -0,0 +1,53 @@
+name: Docs
+
+on:
+ push:
+ branches:
+ - master
+
+jobs:
+ website:
+ runs-on: ubuntu-latest
+
+ name: "Build website"
+
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v2
+
+ - name: Install PHP with latest composer
+ uses: shivammathur/setup-php@v2
+ with:
+ php-version: 8.1
+
+ - name: Build API docs
+ run: |
+ pushd docs/apigen
+ composer install
+ composer exec -- apigen
+ popd
+
+ - name: Build website
+ run: |
+ cd docs
+ wget -q -O - "https://github.com/getzola/zola/releases/download/v0.16.1/zola-v0.16.1-x86_64-unknown-linux-gnu.tar.gz" | tar xzf -
+ ./zola build
+
+ - name: Copy demo & SimplePie
+ run: |
+ cp -r autoloader.php idn/ src/ library/ demo/ docs/public/
+ grep --perl-regexp --only-matching --null-data "(?s)(.+)(?=<!DOCTYPE html>)" demo/index.php > docs/public/demo/index.php
+ grep --perl-regexp --only-matching --null-data "(?s)(.+)(?=<!-- BODY START -->)" docs/public/demo/index.html >> docs/public/demo/index.php
+ grep --perl-regexp --only-matching --null-data "(?s)(?<=<!-- BODY START -->)(.+)(?=<!-- BODY END -->)" demo/index.php >> docs/public/demo/index.php
+ grep --perl-regexp --only-matching --null-data "(?s)(?<=<!-- BODY END -->)(.+)" docs/public/demo/index.html >> docs/public/demo/index.php
+ rm docs/public/demo/index.html
+
+ - name: Upload to web server
+ uses: SamKirkland/[email protected]
+ with:
+ local-dir: docs/public/
+ server: ${{ vars.SFTP_SERVER }}
+ port: ${{ vars.SFTP_SERVER }}
+ protocol: ftps
+ username: ${{ secrets.SFTP_USERNAME }}
+ password: ${{ secrets.SFTP_PASSWORD }}
diff --git a/.gitignore b/.gitignore
@@ -3,7 +3,10 @@ demo/cache/*
 SimplePie.compiled.php
 bin/
 vendor/
-composer.lock
+/composer.lock
 phpunit.xml
 .php-cs-fixer.cache
 .phpunit.result.cache
+docs/public/
+docs/content/api/
+docs/static/api/
diff --git a/demo/index.php b/demo/index.php
@@ -100,7 +100,7 @@
 <div id="site">
 
  <div id="content">
-
+ <!-- BODY START -->
  <div class="chunk">
  <form action="" method="get" name="sp_form" id="sp_form">
  <div id="sp_input">
@@ -234,6 +234,7 @@
  <?php endif; ?>
 
  </div>
+ <!-- BODY END -->
 
  <div>
  <!-- Display how fast the page was rendered. -->

diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,7 @@
+This directory contains the source for the SimplePie website hosted at <https://simplepie.org>. It is mostly written in [CommonMark](https://commonmark.org/) and built using [Zola](https://www.getzola.org) static site generator.
+
+After [installing Zola](https://www.getzola.org/documentation/getting-started/installation/), you can run `zola serve` in this directory to start a server that will allow you to preview the built site, automatically rebuilding on changes.
+
+To build API docs run `composer exec -- apigen` in the `apigen/` directory.
+
+You can also run `zola build`, which will generate the site inside the `public/` subdirectory.
diff --git a/docs/apigen/apigen.neon b/docs/apigen/apigen.neon
@@ -0,0 +1,24 @@
+parameters:
+ paths: [
+ '../../library',
+ '../../src',
+ ]
+
+ exclude: []
+
+ excludeTagged: ['internal']
+
+ baseUrl: '/api/'
+
+ outputDir: '%workingDir%/../content/api'
+
+ themeDir: 'theme'
+
+ title: 'SimplePie 1.8'
+
+# Override ApiGen implementation
+services:
+ renderer.urlGenerator:
+ factory: SimplePie\ApiGen\MdUrlGenerator(ApiGen\Helpers::baseDir(%paths%), %baseUrl%)
+ renderer.latte.extension:
+ factory: SimplePie\ApiGen\LatteExtension
diff --git a/docs/apigen/composer.json b/docs/apigen/composer.json
@@ -0,0 +1,14 @@
+{
+ "require": {
+ "php": "^8.0",
+ "psr/simple-cache": "^3.0"
+ },
+ "require-dev": {
+ "apigen/apigen": "^7.0.0-alpha.3"
+ },
+ "autoload": {
+ "psr-4": {
+ "SimplePie\\ApiGen\\": "src"
+ }
+ }
+}