search

mkdocs / mkdocs-basic-theme

An example very very simple MkDocs theme
BSD 2-Clause "Simplified" License
52 stars 38 forks source link

Default Theme Setting Prevents Build #15

Open EricPonvelle opened 4 years ago

EricPonvelle commented 4 years ago

When I cloned and served the template, I received this error:

`INFO - Building documentation... ERROR - Config value: 'theme'. Error: Unrecognised theme name: 'basictheme'. The available installed themes are: mkdocs, readthedocs, material, cerulean, cosmo, cyborg, darkly, flatly, journal, litera, lumen, lux, materia, minty, pulse, sandstone, simplex, slate, solar, spacelab, superhero, united, yeti

Aborted with 1 Configuration Errors!`

In the mkdocs.yaml file, the theme name was set to "basictheme" which is the name of the folder. I changed this to be

Theme: name: null custom_dir: basic_theme

This allows the build to succeed, but it looks extremely basic. I attached a screenshot. Is this the intended look of the Basic template?

mdocstemplate

gustavneustadt commented 3 years ago

Seems like intended behavior. Take a look at the Documentation.

Generally, when building your own custom theme, the theme.name configuration setting would be set to null. However, if the theme.custom_dir configuration value is used in combination with an existing theme, the theme.custom_dir can be used to replace only specific parts of a built-in theme. For example, with the above layout and if you set name: "mkdocs" then the main.html file in the theme.custom_dir would replace the file of the same name in the mkdocs theme but otherwise the mkdocs theme would remain unchanged. This is useful if you want to make small adjustments to an existing theme.