2023-06-02 14:38:55 +03:00
|
|
|
|
# FAQs – Material for MkDocs
|
|
|
|
|
|
|
|
|
|
|
|
In this section, you will find the most frequently asked questions related to
|
|
|
|
|
|
Material for MkDocs. As we maintainers have decided to monetize Material for
|
|
|
|
|
|
MkDocs, to spend more time working on this project, we have divided the project
|
|
|
|
|
|
and its features into two versions with two repositories.
|
|
|
|
|
|
|
|
|
|
|
|
:fontawesome-solid-people-group: __Community version__ – a public
|
|
|
|
|
|
repository that includes all the basic features and is updated once the funding
|
|
|
|
|
|
goals are reached
|
|
|
|
|
|
|
|
|
|
|
|
:fontawesome-solid-people-arrows: __Insiders verion__ – a private
|
|
|
|
|
|
repository exclusively for our Insiders, which contains more exclusive features
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## General
|
|
|
|
|
|
|
|
|
|
|
|
__What is the difference between Material for MkDocs and other documentation frameworks?__
|
2023-06-29 16:29:16 +03:00
|
|
|
|
|
|
|
|
|
|
Material for MkDocs is a documentation framework built on top of MkDocs, a
|
|
|
|
|
|
popular static site generator. It also offers advanced theming options, a wide range of plugins,
|
2023-06-02 14:38:55 +03:00
|
|
|
|
and custom components that make it easy to create professional-looking
|
|
|
|
|
|
documentation sites quickly and efficiently.
|
|
|
|
|
|
|
|
|
|
|
|
[other documentation]: ../alternatives
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Licensing
|
|
|
|
|
|
|
|
|
|
|
|
__Under which license does Material for MkDocs run?__
|
2023-06-29 16:29:16 +03:00
|
|
|
|
|
|
|
|
|
|
Material for MkDocs runs under the [MIT License], which means that it is free
|
2023-06-02 14:38:55 +03:00
|
|
|
|
for everyone to use, copy, modify, merge, publish, distribute, sublicense,
|
|
|
|
|
|
and/or sell copies of the software.
|
|
|
|
|
|
|
|
|
|
|
|
[MIT License]: ../license
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Support
|
|
|
|
|
|
|
|
|
|
|
|
__I have a question. Where do I ask it?__
|
2023-06-29 16:29:16 +03:00
|
|
|
|
|
|
|
|
|
|
You can ask your question on our [discussion board]. We are all about building
|
2023-06-02 14:38:55 +03:00
|
|
|
|
an open, supportive community where everyone can share their knowledge and
|
|
|
|
|
|
insights. This approach allows us to maintain transparency and ensures all our
|
|
|
|
|
|
users access the same information. We encourage all our users to visit this
|
|
|
|
|
|
[discussion board] or our [issue tracker] to search for previous discussions to
|
|
|
|
|
|
see if their question has been addressed before or address a new discussion.
|
|
|
|
|
|
|
|
|
|
|
|
[discussion board]: https://github.com/squidfunk/mkdocs-material/discussions
|
|
|
|
|
|
[issue tracker]: https://github.com/squidfunk/mkdocs-material/issues
|
