docs: Switch from doxygen to docusaurus (#30)

* install docusaurus
* add docusaurus to docs workflow
* ignore docusaurus from language statistics

.gitattributes

@@ -0,0 +1 @@
+docs/** linguist-vendored

.github/workflows/documentation.yml

@@ -11,29 +11,24 @@ jobs:
     steps:
       - name: Checkout Graaf repository
         uses: actions/checkout@v3
-
-      - name: Pull custom Doxygen theme
-        uses: actions/checkout@master
-        with:
-            repository: jothepro/doxygen-awesome-css
-            ref: v2.2.0
-            path: doxygen-awesome-css
 
-      - name: Install Doxygen
-        run: sudo apt-get install doxygen graphviz -y
-        shell: bash
+      # Node is required for npm
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: "18"
 
-      - name: Generate Doxygen Documentation
-        run: doxygen docs/Doxyfile
-        shell: bash
-
-      - name: Create .nojekyll (ensures pages with underscores work on gh pages)
-        run: touch docs/html/.nojekyll
-        shell: bash
+      - name: Build Docusaurus website
+        run: |
+          cd docs
+          npm install 
+          npm run build
 
       - name: Deploy to GitHub Pages
-        uses: JamesIves/github-pages-deploy-action@v4
+        if: success()
+        uses: crazy-max/ghaction-github-pages@v2
         with:
-            token: ${{ secrets.GITHUB_TOKEN }}
-            branch: gh-pages
-            folder: docs/html
+          target_branch: gh-pages
+          build_dir: docs/build
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -1,14 +1,14 @@
-<p align="center"><img src="docs/img/graaf.png"></p>
+<p align="center"><img src="docs/static/img/graaf.png"></p>
 <h1 align="center">Graaf Lib</h1>
 
 <p align="center">
-  Graaf is a general-purpose lightweight C++ library designed for versatile graph operations. Graaf allows users to easily create, modify, and query graphs. It is well-suited for various graph-based applications, including social network analysis, CNNs, and more.
+  Graaf is a general-purpose lightweight graph library implemented in C++. Graaf allows users to easily create, modify, and query graphs. It is well-suited for various graph-based applications, including social network analysis, CNNs, and more.
 </p>
 
 <p align="center">
   <a href="https://github.com/bobluppes/graaf/actions/workflows/main-ci.yml"><img src="https://github.com/bobluppes/graaf/actions/workflows/main-ci.yml/badge.svg" height="20"></a>
   <a href="https://codecov.io/github/bobluppes/graaf"><img src="https://codecov.io/github/bobluppes/graaf/branch/main/graph/badge.svg?token=ZFBLNFN39C" height="20"></a>
-  <a href="https://bobluppes.github.io/graaf/"><img src="https://img.shields.io/badge/documentation-doxygen-%23ff69b4" height="20"></a>
+  <a href="https://bobluppes.github.io/graaf/"><img src="https://img.shields.io/badge/documentation-docusaurus-%23ff69b4" height="20"></a>
   <a href="LICENSE.md"><img src="https://img.shields.io/badge/license-MIT-black" height="20"></a>
 </p>
 

docs/.gitignore

@@ -0,0 +1,3 @@
+.docusaurus/
+build/
+node_modules/