AdiDoks is a mordern documentation theme, which is a port of the Hugo theme Doks for Zola.
Before using the theme, you need to install the Zola ≥ 0.13.0.
git clone git@github.com:aaranxu/adidoks.git
cd adidoks
zola serve
# open http://127.0.0.1:1111/ in the browser
Read more from the document of the AdiDoks.
Just earlier we showed you how to run the theme directly. Now we start to install the theme in an existing site step by step.
zola init mysite
Download this theme to your themes directory:
cd mysite/themes
git clone git@github.com:aaranxu/adidoks.git
Or install as a submodule:
cd mysite
git init # if your project is a git repository already, ignore this command
git submodule add git@github.com:aaranxu/adidoks.git themes/adidoks
Enable the theme in your config.toml
in the site derectory:
theme = "adidoks"
Or copy the config.toml.example
from the theme directory to your project's
root directory:
cp themes/adidoks/config.toml.example config.toml
You can copy the content from the theme directory to your project:
cp -r themes/adidoks/content .
You can modify or add new posts in the content/blog
, content/docs
or other
content directories as needed.
Just run zola serve
in the root path of the project:
zola serve
AdiDoks will start the Zola development web server accessible by default at
http://127.0.0.1:1111
. Saved changes will live reload in the browser.
You can customize your configurations, templates and content for yourself. Look
at the config.toml
, theme.toml
, content
files and templates files in this
repo for an idea.
There are some configuration options that you can customize in config.toml
.
Set the authors's taxonomies for the site.
taxonomies = [
{name = "authors"},
]
Use search function for the content.
build_search_index = true
The following options should be under the [extra]
in config.toml
alanguage_code
- set HTML file language (default toen-US
)theme_color
- your site's HTML color (default to#fff
)title_separator
- the separator to your site title, like|
and-
(defaults to|
)title_addition
- the additon content for the title of the homepagetimeformat
- the timeformat for the blog article published datetimezone
- the timezone for the blog article published dateedit_page
(anddocs_repo
,repo_branch
) - whether to show the edit page in the github repo for your docsmath
(andlibrary
) - set KaTeX or MathJax library[extra.open]
- Open Graph + Twitter Cards for the site[extra.schema]
- set JSON-LD for the site[[extra.menu.main]]
- the header navigations for the site[[extra.menu.social]]
- the social links on the header of the page[extra.footer]
- the footer content on the left[[extra.footer.nav]]
- the footer navigations on the right[extra.home]
- the main content of the homepage[[extra.home.list]]
- the lists' content of the homepage
All pages are extend to the base.html
, and you can customize them as need.
Go to the config.toml
to set your own homepage content.
Each section includes a _index.md
, and you can customize it or add your new
section under the content
folder.
There are mainly three types of pages in the site.
blog
- blog articledocs
- documentation articleauthors
- authors page if you need to add some information for a new author
We use GitHub Issues as the official bug tracker for the AdiDoks. 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.
We'd love your help! Please see CONTRIBUTING.md to learn about the kinds of contributions we're looking for.
AdiDoks is distributed under the terms of the MIT license.