OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
squidfunk 2021-02-26 16:41:00 +01:00
parent 4b6edc1c49
commit 9c30ddbd8b
2 changed files with 16 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -91,8 +91,8 @@
layout respects the user's default font size.
* **Modern architecture** — Material for MkDocs's underlying codebase is built
with TypeScript, RxJS, and SCSS, and is compiled with Webpack, bringing
excellent possibilities for theme extension and customization.
on top of TypeScript, RxJS, and SCSS, bringing excellent possibilities for
theme extension and customization.
_Material for MkDocs uses the [sponsorware][3] release strategy, which means
that new features are first exclusively released to sponsors as part of Material

21
docs/customization.md
View File

@ -205,19 +205,26 @@ For more on this topic refer to the [MkDocs documentation][5].
## Theme development
Material for MkDocs uses [ESBuild][6] as a build tool to leverage modern web
technologies like [TypeScript][7] and [SASS][8]. If you want to make more
fundamental changes, it may be necessary to make the adjustments directly in
the source of the theme and recompile it.
Material for MkDocs is built on top of [TypeScript][6], [RxJS][7] and [SASS][8],
and uses a lean, custom build process to put everything together.[^1] If you
want to make more fundamental changes, it may be necessary to make the
adjustments directly in the source of the theme and recompile it.
[6]: https://esbuild.github.io/
[7]: https://www.typescriptlang.org/
[^1]:
Prior to version 7.0, the build was based on Webpack. This led to broken
builds due to frequent incompatibilities with loaders and plugins, so we
decided to swap Webpack for a leaner custom solution which is now based on
[RxJS][7] as the application itself. This enabled us to remove more than
500 dependencies (~30% less).
[6]: https://www.typescriptlang.org/
[7]: https://github.com/ReactiveX/rxjs
[8]: https://sass-lang.com
### Environment setup
In order to start development on Material for MkDocs, a [Node.js][9] version of
at least 12 is required. First, clone the repository:
at least 14 is required. First, clone the repository:
```
git clone https://github.com/squidfunk/mkdocs-material