17
0
Fork 0
Aerogramme website including blog system and documentation using Zola
Go to file
Alex 1559433753
Add shell.nix and update garage source, include api docs copy
2022-11-16 12:06:57 +01:00
content Merge pull request 'Templates changes and doc updates for v0.8' (#11) from v0.8 into master 2022-09-29 17:30:50 +02:00
garage@bcc9772470 Add shell.nix and update garage source, include api docs copy 2022-11-16 12:06:57 +01:00
src Style for <hr> element on blog posts 2022-02-01 17:23:44 +01:00
static update doc and add min-h-screen 2022-02-02 13:16:01 +01:00
templates Merge pull request 'Templates changes and doc updates for v0.8' (#11) from v0.8 into master 2022-09-29 17:30:50 +02:00
.drone.yml Add shell.nix and update garage source, include api docs copy 2022-11-16 12:06:57 +01:00
.gitignore Add shell.nix and update garage source, include api docs copy 2022-11-16 12:06:57 +01:00
.gitmodules Documentation from garage submodule 2022-02-02 10:07:26 +01:00
README.md update readme 2022-01-29 14:59:22 +01:00
config.toml Small templates changes 2022-09-14 19:33:05 +02:00
package-lock.json First commit 2022-01-24 18:36:50 +01:00
package.json First commit 2022-01-24 18:36:50 +01:00
shell.nix Add shell.nix and update garage source, include api docs copy 2022-11-16 12:06:57 +01:00
tailwind.config.js Beautify download button 2022-01-28 01:20:33 +01:00

README.md

Garage Website

¡ Work in progress (almost done) !


Setup

  • Install Zola with pacman -S zola
  • Clone this repo
  • Run npm install to get the dev dependencies
  • Run zola build to get the public directory
  • Run npm start to compile styles and scripts
  • Run zola serve

Build

CSS : 28.4 kB

JS : 6.8 kB (app) + 1.2 MB (search)*

*The search index in loaded only when the user opens the search modal

Images + Icons : 1.1 MB

Fonctions & utilities

JavaScript can be disabled and the website will still run nicely. It only brings QoL advantages for the user.

The function is [x] if it still runs without JavaScript enabled.

  • Responsive main navigation menu (toggle)
  • Documentation : user can deploy or reploy ToC submenus
  • Documentation : deploy only the current ToC submenu after a page change
  • Documentation : sidebar focus effect on current section anchor when user scrolls
  • Documentation : ToC that follows the user's scroll
  • Global search

Screenshots

480px

768px

1280px