aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorsptaule <lecas83@gmail.com>2022-01-29 14:42:09 +0100
committersptaule <lecas83@gmail.com>2022-01-29 14:42:09 +0100
commite6f8f43b6ca5ff00d33b3a539e67eb2255fa1dd0 (patch)
tree1c08c3482e3ac79de1b040d77e3ca3d4f37b8fad /README.md
parente958d4a1d06878100170cd96ce548966e3d5222a (diff)
downloadgaragehq.deuxfleurs.fr-e6f8f43b6ca5ff00d33b3a539e67eb2255fa1dd0.tar.gz
garagehq.deuxfleurs.fr-e6f8f43b6ca5ff00d33b3a539e67eb2255fa1dd0.zip
Improve responsive, icons, refactor search, update readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md45
1 files changed, 43 insertions, 2 deletions
diff --git a/README.md b/README.md
index 25416e5..c85fe6a 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# Garage Website
-¡ Work in progress !
+¡ Work in progress (almost done) !
---
@@ -11,4 +11,45 @@
- 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` \ No newline at end of file
+- Run `zola serve`
+
+## Build
+
+CSS : `28.4 kB`
+
+JS : `6.8 kB (app)` + `1.2 MB (search)`*
+
+*<em>The search index in loaded only when the user opens the search modal</em>
+
+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 <u>without</u> JavaScript enabled.
+
+- [x] Responsive main navigation menu (toggle)
+- [x] 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
+
+<div style="display:grid;grid-template-columns: repeat(3, 1fr);grid-gap: 10px;grid-auto-rows: minmax(100px, auto);">
+ <p style="text-align:center;margin-bottom:5rem;">
+ <span>480px</span>
+ <img src="static/screenshots/screenshot-480.png" />
+ </p>
+ <p style="text-align:center;margin-bottom:5rem;">
+ <span>768px</span>
+ <img src="static/screenshots/screenshot-768.png" />
+ </p>
+ <p style="text-align:center;margin-bottom:5rem;">
+ <span>1280px</span>
+ <img src="static/screenshots/screenshot-1280.png" />
+ </p>
+</div> \ No newline at end of file