UI Navigation
UI Navigation, or known as zluinav, is a Zola theme designed for accessibility rather than visual and made as easy as possible using templates and macros. Since I am a blind developer, I'd like to develop with accessibility as possible so visually impaired users can use them.
This theme is also available for Hugo at Hguinav.
Zola is a fast site generator written in Rust powered by tera as its templating engine and has a powerful theme creation feature.
License
This theme is distributed under the terms of the MIT License.
Features of zluinav theme
- Blog with pagination enabled; multiple blogs can be created by copying the blog directory in the content folder to the new directory for a new blog. This means that you can have multiple blogs in one site. In fact, Zola doesn't have its build-in posts, but it is possible using sections.
- Documentation site; build accessible documentation sites by using built-in 1subsection templates specifically designed for documentation.
- Multilingual; build your site in multiple languages.
- Custom navigation; can be set via
config.extra.nav. - Customizable extrahead, header, navigation, and footer by base templates and blocks.
- Fast; Zola generates within a few milliseconds. Zluinav is built with HTML using aria whenever possible for accessibility with assistive screen reader as well as using JavaScript. You can rebase the templates, should you wish to add your own content.
- Copy code blocks; add code blocks which can then be copied using buttons and display the code language if available, helped by JavaScript.
- Variables; add variables to your page content to be replaced during the site generate.
- Local date display; display dates in user's local timezone, no madder what timezone the date is set.
- Use macros and shortcodes to make your content length shorten.
- Comprehensive documentation; Zluinav provides a full Comprehensive documentation including possible templates, shortcodes, blocks, configurable parameters, and more, everything as it updates.
Installation
Using git:
cd themes
git clone https://github.com/harrymkt/zluinav.git
Or download manually and paste in the themes directory.
Or, add to the Git submodule
git submodule add --name zluinav https://github.com/harrymkt/zluinav.git themes/zluinav
git submodule update --remote
In your config.toml file, add the following
theme = "zluinav"
Customization
For more customizable options and configurations, please see documentation
Contribution
Contributions to this theme are welcome, provided that the following requirements are met:
- Use 2 level space indentation for HTML. Use 1 tab level indentation for CSS and JavaScript. If Markdown files need indentation, use 1 tab.
- Be the templates accessible for visually impaired and/or blind and prefer readability. Don't worry, I will process in case accessibility issues before pull requests are merged.
- Photos are not required in this theme. You may design with CSS for visual if you so wish.
Thank you!