docs: build with eleventy instead of jekyll (#9146)

Author: alxndrsn

.dockerignore

@@ -28,11 +28,5 @@ jobs:
           persist-credentials: false
       - uses: ./.github/actions/install-node-package
         with:
-          node-version: 22
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 2.7
-          bundler-cache: true
-      - run: sudo gem install bundler -v 2.1.4
-      - run: npm run install-jekyll
+          node-version: 24
       - run: BUILD=1 npm run build-site

.github/workflows/docs.yml

@@ -3,7 +3,6 @@ tmp*
 /node_modules
 docs/_site
 docs/static/css
-docs/.jekyll-cache
 npm-debug.log
 npm-debug.log.*
 *~

.gitignore

@@ -97,16 +97,7 @@ Now when you visit https://github.com/myfork/pouchdb there should be a button th
 Building PouchDB Documentation
 --------------------------------------
 
-The source for the website http://pouchdb.com is stored inside the `docs` directory of the PouchDB repository, you can make changes and submit pull requests as with any other patch. To build and view the website locally you will need to have the Ruby development package installed.
-On Ubuntu this is done with:
-
-    $ sudo apt install -y ruby-dev
-
-You then neet to install [jekyll](http://jekyllrb.com/) and a few other gems. Jekyll is installed using [bundler](http://bundler.io/) so you need to install that first.
-On Ubuntu you will need root permissions to do this so prefix the ```gem``` command with ```sudo```
-
-    $ [sudo] gem install bundler
-    $ npm run install-jekyll
+The source for the website http://pouchdb.com is stored inside the `docs` directory of the PouchDB repository, you can make changes and submit pull requests as with any other patch.
 
 If you haven't already done so, you'll also need to run `npm install` to pull in packages for the dev server:
 
@@ -118,10 +109,6 @@ Now you can build the site and start the dev server with:
 
 You should now find the documentation at http://127.0.0.1:4000
 
-You can also build and run the documentation with docker:
-
-    $ npm run dev-site-with-docker
-
 Writing a PouchDB Blog Post
 --------------------------------------
 
@@ -166,7 +153,7 @@ Release Procedure
  * `npm run set-version -- $VERSION`
  * `npm run release`. Note that with 2FA in npm, it will request you an OTP for every package.
  * Copy the `dist/pouchdb*` files from the $VERSION tag on github, paste the release notes and add the distribution files to Github Releases, rename `pouchdb.min.js` to `pouchdb-$VERSION.min.js` (same with `pouchdb.js`) after you upload it.
- * Update docs/_config.yml to the current version
+ * Update `docs/_data/site.js` to the current version
  * Push updated versions to master
  * `npm run publish-site`
 

CONTRIBUTING.md

@@ -17,14 +17,6 @@ const POUCHDB_LESS = resolvePath('docs/src/less/pouchdb/pouchdb.less');
 
 process.chdir('docs');
 
-async function checkJekyll() {
-  try {
-    await exec('bundle check');
-  } catch (err) {
-    throw new Error('Jekyll is not installed.  You need to do: npm run install-jekyll');
-  }
-}
-
 async function buildCSS() {
   fs.mkdirSync(__dirname + '/../docs/static/css', { recursive:true });
   const cmd = [ resolvePath('node_modules/less/bin/lessc'), POUCHDB_LESS ].join(' ');
@@ -34,9 +26,10 @@ async function buildCSS() {
   console.log('Updated:', POUCHDB_CSS);
 }
 
-async function buildJekyll() {
-  await exec('bundle exec jekyll build');
-  console.log('=> Rebuilt jekyll');
+async function buildEleventy() {
+  await exec('npx @11ty/eleventy');
+  await checkForUnprocessedCurlies();
+  console.log('=> Rebuilt eleventy');
 
   highlightEs6();
   console.log('=> Highlighted ES6');
@@ -62,6 +55,28 @@ async function buildJekyll() {
   }
 }
 
+async function checkForUnprocessedCurlies() {
+  // If unprocessed curlies are ever desired, add a way to ignore them.
+  try {
+    const res = await exec(`grep -Ern --include=\\*.html '\\{\\{|\\}\\}' ./_site/`);
+
+    console.log();
+    console.log('!!! UNPROCESSED CURLIES FOUND IN OUTPUT HTML FILE(S):');
+    console.log(res.stdout.trim());
+    console.log('!!! CHECK TEMPLATES ARE BEING FULLY PROCESSED.');
+    console.log();
+
+    if (process.env.BUILD) {
+      process.exit(1);
+    }
+  } catch (err) {
+    if (err.code === 1) {
+      return; // no problems found
+    }
+    throw err;
+  }
+}
+
 function highlightEs6() {
   const path = resolvePath('docs/_site');
 
@@ -83,9 +98,8 @@ function onError(err) {
 
 function buildEverything() {
   return Promise.resolve()
-    .then(checkJekyll)
     .then(buildCSS)
-    .then(buildJekyll)
+    .then(buildEleventy)
     .catch(onError);
 }
 
@@ -95,24 +109,25 @@ function resolvePath(projectLocalPath) {
 
 if (!process.env.BUILD) {
   const http_server = require('http-server');
-  const watchGlob = require('glob-watcher');
+  const globWatcher = require('glob-watcher');
+  const watchGlob = (path, fn) => globWatcher(path, () => fn().catch(console.log));
 
   // Simpler ways of blacklisting certain paths here would be very welcome.
   fs.readdirSync('.')
     .forEach(path => {
-      if (path === '_site' || path.startsWith('Gemfile')) {
+      if (path === '_site') {
         return;
       }
 
       if (fs.statSync(path).isDirectory()) {
-        watchGlob(`${path}/**`, buildJekyll);
+        watchGlob(`${path}/**`, buildEleventy);
       } else {
-        watchGlob(path, buildJekyll);
+        watchGlob(path, buildEleventy);
       }
     });
 
 
-  watchGlob('static/src/*/*.less', buildCSS);
+  watchGlob('src/less/**', buildCSS);
 
   http_server.createServer({root: '_site', cache: '-1'}).listen(4000);
   console.log('Server address: http://localhost:4000');

bin/build-site.js

@@ -0,0 +1 @@
+/asf.md