📂 Zola Docs

Zola Docs is an easy way to create documentation for your project.

Check out the demo.

🚀 Quick Start

Before using the theme, you need to install Zola ≥ v0.18.0.

# 1. Clone the repo
git clone git@github.com:semanticdata/zola-docs.git

# 2. Change directory into clone
cd zola-docs

# 3. Serve the site locally
zola serve

# 4. Open http://127.0.0.1:1111/ in the browser

For more detailed instructions, visit the Documentation page about installing and using themes.

🎨 Customization

You can change the configuration, templates and content yourself. Refer to the config.toml, and templates for ideas. In most cases you only need to modify the contents of config.toml to customize the appearance of your blog. Make sure to visit the Zola Documentation.

Adding custom CSS is as easy as adding your styles to sass/_custom.scss. This is made possible because SCSS files are backwards compatible with CSS. This means you can type normal CSS code into a SCSS file and it will be valid.

🚩 Reporting Issues

We use GitHub Issues as the official bug tracker for Zola Docs. Please search existing issues. It’s possible someone has already reported the same problem. If your problem or idea is not addressed yet, open a new issue.

📝 Notes on provided configuration options

These options can be configured in the extra section of the config.toml.

• The easydocs_logo_always_clickable option controls whether the logo is always clickable, even when on the home page. By default, it is only clickable when not on the home page. If this is enabled, the logo will be clickable on the home page as well, refreshing the page.
• The easydocs_uglyurls option provides support for offline sites that do not use a webserver. If set to true, links in the nav are generated with the full path including index.html. This functionality was inspired by the Abridge theme. Note that for this to work, it also requires the base_url to be set to the local folder where the site will be stored, e.g. base_url = file:///home/user/mysite/public/. Therefore this is not portable and only works with a specific local folder, but does not require a webserver to navigate the site.
• The easydocs_heading_threshold option controls the minimum number of headings needed on a page before headings show in the navigation on the left. The default is 5. This can be used to always show headings on each page by setting it to 1.

🔄 Changes from Upstream

• Refactored stylesheets.
• Added partials templates
• Added test and deployment workflows.

💜 Acknowledgements

• Zola Docs is a fork of Zola Easydocs.
• Icons used: Office UI Fabric Icons.
• Copy-code-button: Aaron Luna.

© License

Source code in this repository is available under the MIT License.