Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add guide for simple websites with navigation? #41

Open
mandrasch opened this issue Mar 4, 2024 · 0 comments
Open

Docs: Add guide for simple websites with navigation? #41

mandrasch opened this issue Mar 4, 2024 · 0 comments

Comments

@mandrasch
Copy link

Hey,

I tested out vituum for the first time and was really impressed how much effort has gone into this, especially the support for template languages. 😮 Much respect for this! 👏 👏 👏

Just wanted to provide some feedback as first-time-user, maybe it's helpful:

What I personally missed in the docs was a straight forward way to

  1. install vituum
  2. select templating language
  3. add base template / layout file
  4. add header navigation
  5. add sub-sites
  6. add modular js per site (haven't figured this out yet)
  7. Info about how to deploy this (I needed to add .html to my header nav links, otherwise I got 404)

(This was the use case why I'm mainly interested in vituum for small web experiments, because it offers a straight forward way for multiple sub-pages without having to use a full 11ty, astro, sveltekit, nuxt, nextjs, ... setup. But rather to start with Vite and go on from there 👍 )

My project: https://github.com/mandrasch/vituum-p5js

I could figure out what I had to do + the examples helped. But I had to look in different places to gather that information -> could be improved.

Also a recommended templating language would be maybe cool for first-time users. liquid could be a good recommendation because it has a prettier plugin (which is missing for twig unfortunately).

Happy to help with this guide / contribute a draft if this is interesting!

If not relevant, please feel free to just close this issue.

Cheers and much success,
Matthias

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant