build: transform the guideline into a webpage

By transforming the guidelines project into a webpage, now the
contents of the documentation can be hosted through GitHub Pages
as with any other source of documentation.
Also, better navigation and styling can be achieved if needed,
specially with image and others. tyle of the page resembles that
of the generated TypeDoc, making it easy for the developers to
navigate all the documentation pages now.
A page about the guidelines project itself has been added, the
pages for the community had been splitted, and miner styling
has been done through all content pages.

BREAKING CHANGE: The whole project structure has changed.

.editorconfig

@@ -1,21 +1,12 @@
-# http://editorconfig.org
-
 root = true
 
 [*]
 charset = utf-8
-end_of_line = lf
 indent_style = space
 indent_size = 4
-trim_trailing_whitespace = true
+end_of_line = lf
 insert_final_newline = true
+trim_trailing_whitespace = true
 
-# Use 2 spaces since npm does not respect custom indentation settings
 [package.json]
-indent_style = space
-indent_size = 2
-
-# Use 2 spaces since npm does not respect custom indentation settings
-[**/package-definition.json]
-indent_style = space
 indent_size = 2

.github/workflows/on-commit-publish.yml

@@ -0,0 +1,41 @@
+name: on-commit-publish
+
+on:
+    push:
+    workflow_dispatch:
+
+permissions:
+    contents: read
+    pages: write
+    id-token: write
+
+concurrency:
+    group: 'pages'
+    cancel-in-progress: false
+
+jobs:
+    publish-docs:
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v4
+            - name: Setup node version
+              uses: actions/setup-node@v4
+              with:
+                  node-version: '20'
+            - name: Installing project dependencies
+              run: npm install
+            - name: Building the site
+              run: npm run build
+            - name: Setup Pages
+              uses: actions/configure-pages@v4
+            - name: Upload artifact
+              uses: actions/upload-pages-artifact@v3
+              with:
+                  path: './dist'
+            - name: Deploy to GitHub Pages
+              id: deployment
+              uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,20 @@
+# OS generated files #
+.DS_Store
+Thumbs.db
+.tmp/
+
+# IDE generated file #
+.idea/
+
+# PackageManager specific lock files
+pnpm-lock.yaml
+package-lock.json
+yarn.lock
+
+# Node generated files
+node_modules/
+npm-debug.log
+yarn-error.log
+
+# Gnerated folder for site
+dist/

README.md

@@ -2,10 +2,12 @@
 
 This repository contains documentation on the platform architecture, design guidelines, ways to contribute, and standards used, related to the development of **GobstonesWeb2**.
 
-[![License](https://img.shields.io/github/license/gobstones/gobstones-guidelines?style=plastic&label=License&logo=open-source-initiative&logoColor=white&color=olivegreen)](https://github.com/gobstones/gobstones-guidelines/blob/main/LICENSE) 
-[![Version](https://img.shields.io/github/v/tag/gobstones/gobstones-guidelines?color=crimson&label=Version&logo=git-lfs&logoColor=white&sort=semver&style=plastic)](https://github.com/gobstones/gobstones-guidelines)
+[![License](https://img.shields.io/github/license/gobstones/gobstones-guidelines?style=plastic&label=License&logo=open-source-initiative&logoColor=white&color=olivegreen)](https://github.com/gobstones/gobstones-guidelines/blob/main/LICENSE)
+[![Version](https://img.shields.io/github/package-json/v/gobstones/gobstones-guidelines?style=plastic&label=Version&logo=git-lfs&logoColor=white&color=crimson)](https://github.com/gobstones/gobstones-guidelines)
 
-If you are planning on contributing to the development of **GobstonesWeb2** in any way, please start by reading the following guidelines.
+If you are planning on contributing to the development of **GobstonesWeb2** in any way, please start by reading the guidelines.
+
+### Find the guidelines start page [**here**](https://gobstones.github.io/gobstones-guidelines)
 
 Be sure to:
 * Understand how **GobstonesWeb2** architecture is organized in different repositories.
@@ -14,6 +16,5 @@ Be sure to:
 * Get to know the project governance chain and communication channels.
 * Maintain the code standards for all projects and code submissions.
 
-## Contributing
-In order to contribute, be sure to understand everything defined in these guidelines.
-Start at the [**Introduction**](./sections/introduction.md) guiding you through all the sections.
+If you want to know more about this repository itself, you may read the [about the guidelines](https://gobstones.github.io/gobstones-guidelines/about-guidelines) section in the guidelines.
+

eleventy.config.js

@@ -0,0 +1,57 @@
+const markdownIt = require('markdown-it');
+const markdownItAnchor = require('markdown-it-anchor');
+const eleventySass = require('eleventy-sass');
+
+const syntaxHighlight = require('@11ty/eleventy-plugin-syntaxhighlight');
+const eleventyNavigationPlugin = require('@11ty/eleventy-navigation');
+
+module.exports = function (el) {
+    /*
+     * Copy your _assets elements directly to a subfolder or
+     * file in the output. You may add more files if required.
+     */
+    el.addPassthroughCopy('src/css');
+    el.addPassthroughCopy('src/js');
+    el.addPassthroughCopy('src/img');
+    el.addPassthroughCopy('src/favicon.ico');
+
+    /*
+     * Add plugins.
+     * Add yours at the bottom if needed.
+     */
+    el.addPlugin(eleventySass);
+    el.addPlugin(syntaxHighlight);
+    el.addPlugin(eleventyNavigationPlugin);
+
+    /*
+     * Set the markdown library to use, use a custom instance to
+     * allow the addition of markdown-it-anchor plugin
+     */
+    el.setLibrary('md', markdownIt({ html: true }).use(markdownItAnchor, {
+        permalink: markdownItAnchor.permalink.linkAfterHeader({
+            class: 'anchor',
+            assistiveText: title => `Permalink to “${title}”`,
+            visuallyHiddenClass: 'hidden'
+          })
+    }));
+
+    /*
+     * Set global data that will be used by all pages, as to avoid
+     * having to repeat it in every front matter
+     */
+    el.addGlobalData('layout', 'doc');
+    el.addGlobalData('navOptions', {
+        includeSelf: true, allowMissing: true
+    });
+    el.addGlobalData('devUrl', 'https://localhost:8080');
+    el.addGlobalData('deployUrl', 'https://gobstones.github.io/gobstones-guidelines');
+
+    return {
+        dir: {
+            input: 'src',
+            output: 'dist',
+            includes: 'templates/includes',
+            layouts: 'templates/layouts',
+        },
+    };
+};