mkdocs / mkdocs-basic-theme Goto Github PK

An example very very simple MkDocs theme

License: BSD 2-Clause "Simplified" License

HTML 96.89% CSS 1.16% JavaScript 1.95%

mkdocs-basic-theme's Introduction

MkDocs

Project documentation with Markdown

MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. It is designed to be easy to use and can be extended with third-party themes, plugins, and Markdown extensions.

Please see the Documentation for an introductory tutorial and a full user guide.

Features

Build static HTML files from Markdown files.
Use Plugins and Markdown Extensions to enhance MkDocs.
Use the built-in themes, third party themes or create your own.
Publish your documentation anywhere that static files can be served.
Much more!

Support

If you need help with MkDocs, do not hesitate to get in contact with us!

For questions and high-level discussions, use Discussions on GitHub.
- For small questions, a good alternative is the Chat room on Gitter/Matrix.
To report a bug or make a feature request, open an Issue on GitHub.

Please note that we may only provide support for problems/questions regarding core features of MkDocs. Any questions or bug reports about features of third-party themes, plugins, extensions or similar should be made to their respective projects.
But, such questions are not banned from the chat room.

Make sure to stick around to answer some questions as well!

Contributing to MkDocs

The MkDocs project welcomes, and depends on, contributions from developers and users in the open source community. Please see the Contributing Guide for information on how you can help.

Code of Conduct

Everyone interacting in the MkDocs project's codebases, issue trackers, and discussion forums is expected to follow the PyPA Code of Conduct.

License

BSD-2-Clause

mkdocs-basic-theme's People

Contributors

Stargazers

Watchers

mkdocs-basic-theme's Issues

License file missing

hi,

I noticed in this package there is no license file. Not sure if that is on purpose as it is more a demonstration or if the License was just forgotten.

Just thought I mention it.

Many warnings, please upgrade

After copy folder basic_theme to my project and run with mkdocs build , many WARNINGs

INFO    -  Cleaning site directory 
INFO    -  Building documentation to directory: /home/user/gits/miniguias/DiscussOKBr/site 
WARNING -  Template variable warning: 'google_analytics' is being deprecated and will not be available in a future version. Use 'config.google_analytics' instead. 
WARNING -  Template variable warning: 'favicon' is being deprecated and will not be available in a future version. Use '{{ base_url }}/img/favicon.ico' instead. 
WARNING -  Template variable warning: 'previous_page' is being deprecated and will not be available in a future version. Use 'page.previous_page' instead. 
WARNING -  Template variable warning: 'site_name' is being deprecated and will not be available in a future version. Use 'config.site_name' instead. 
WARNING -  Template variable warning: 'next_page' is being deprecated and will not be available in a future version. Use 'page.next_page' instead. 
WARNING -  Template variable warning: 'toc' is being deprecated and will not be available in a future version. Use 'page.toc' instead. 
WARNING -  Template variable warning: 'page_title' is being deprecated and will not be available in a future version. Use 'page.title' instead. 
WARNING -  Template variable warning: 'repo_url' is being deprecated and will not be available in a future version. Use 'config.repo_url' instead. 
WARNING -  Template variable warning: 'repo_name' is being deprecated and will not be available in a future version. Use 'config.repo_name' instead. 
WARNING -  Your theme does not appear to contain a 'main.html' template. The 'base.html' template was used instead, which is deprecated. Update your theme so that the primary entry point is 'main.html'. 
WARNING -  Template variable warning: 'content' is being deprecated and will not be available in a future version. Use 'page.content' instead.

Default Theme Setting Prevents Build

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?

mkdocs / mkdocs-basic-theme Goto Github PK

mkdocs-basic-theme's Introduction

MkDocs

Features

Support

Links

Contributing to MkDocs

Code of Conduct

License

mkdocs-basic-theme's People

Contributors

Stargazers

Watchers

Forkers

mkdocs-basic-theme's Issues

License file missing

Many warnings, please upgrade

Default Theme Setting Prevents Build

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent