search

ventojs / vento

🌬 A template engine for Deno & Node
https://vento.js.org/
MIT License
153 stars 9 forks source link

docs: improve + simplify #21

Closed uncenter closed 9 months ago

uncenter commented 9 months ago

Most of the files changed are just from running deno fmt, which I assume is the formatter I should be using here. I also updated and renamed the first "core" or "root" pages, but I couldn't figure out how to order them in the left panel. Fixes some grammar issues, makes the examples a little more consistent.

uncenter commented 9 months ago

I'm not a Lume user but is there a better theme we can use? I'm finding the current one a little lacking in features and aesthetic, not to mention it seems difficult to customize because it's in a different repo - can we just pull the theme (https://github.com/lumeland/theme-simple-wiki) into here entirely to make it easier to make changes?

oscarotero commented 9 months ago

Thank you! I don't want to create a website for the documentation for now. And I like the documentation to be a directory with plain markdown files, so they can be used not only to build the site but also to be read directly from GitHub and similar.

Is true that the theme doesn't allow to order the elements in the menu (they are sorted by url). I'll include an option for that.

uncenter commented 9 months ago

Thank you! I don't want to create a website for the documentation for now. And I like the documentation to be a directory with plain markdown files, so they can be used not only to build the site but also to be read directly from GitHub and similar.

Is true that the theme doesn't allow to order the elements in the menu (they are sorted by url). I'll include an option for that.

Great. Do you want (me) to remove the Lume config in docs/ so its just markdown in there?

uncenter commented 9 months ago

Sorry I misunderstood- @oscarotero are you saying the current site is not a documentation website? I'm confused. Do you want docs/ to just be markdown files linked to in the README? What goes on the website, if anything?

oscarotero commented 9 months ago

Sorry, I didn't explain myself very well :)

There's a documentation site (https://vento.js.org/) but I don't want to design a different website or including all stuff (css files, templates, etc) inside this repo. I like the documentation in this repo is only markdown files, so it's independent of the existing website.

The _config.ts is needed by Lume to build the website, so it cannot be deleted.

I'll try to improve the current theme to allow to configure the order of the elements in the navbar.

uncenter commented 9 months ago

Sorry, I didn't explain myself very well :)

There's a documentation site (vento.js.org) but I don't want to design a different website or including all stuff (css files, templates, etc) inside this repo. I like the documentation in this repo is only markdown files, so it's independent of the existing website.

The _config.ts is needed by Lume to build the website, so it cannot be deleted.

I'll try to improve the current theme to allow to configure the order of the elements in the navbar.

Ah okay gotcha. In that case I can help make a few PRs for the current theme in that repo. Thanks for clearing it up!