A Traefik Labs Material Design theme for MkDocs
## Quick start Material for MkDocs can be installed with `pip`: ```sh pip install mkdocs-traefiklabs ``` Add the following line to `mkdocs.yml`: ```yaml theme: name: traefik-labs ``` ## How to run the project in Dev mode ### Pre-requisites - Check your node version, the .nvmrc file mentions the expected version. If you use nvm, you can run `nvm use` to set the correct node version to the environment. - Check if you have `mkdocs` installed locally (it requires Python). You can find installation instructions here: https://www.mkdocs.org/user-guide/installation/ ### Steps: - Install the dependencies `npm install` - `npm run build` - this will generate the '/material' folder with the compiled theme (you need to re-run this if you add assets) - `npm run start` - leave this running in a terminal, it will watch for code changes and rebuild the content (but not the assets) - `npm run serve` - will launch a dev server at 127.0.0.1:8000 with the current theme, it has hot reload (not very precise, sometimes you need to hard refresh the page) > If you wish to set the context to see other products information, you need to set the `product` config in the `mkdocs.yml` file in the project's root directory. The dev server should automatically reload and you will see the changes in the browser. ### Reminders: - The 'material' directory generated by the `npm run build` is the one used in the documentation, so please don't forget running the build once you finish all the changes. TODO: add git hooks and run build on pre-push. %package -n python3-mkdocs-traefiklabs Summary: A Traefik Labs branded Material Design theme for MkDocs Provides: python-mkdocs-traefiklabs BuildRequires: python3-devel BuildRequires: python3-setuptools BuildRequires: python3-pip %description -n python3-mkdocs-traefiklabs
A Traefik Labs Material Design theme for MkDocs
## Quick start Material for MkDocs can be installed with `pip`: ```sh pip install mkdocs-traefiklabs ``` Add the following line to `mkdocs.yml`: ```yaml theme: name: traefik-labs ``` ## How to run the project in Dev mode ### Pre-requisites - Check your node version, the .nvmrc file mentions the expected version. If you use nvm, you can run `nvm use` to set the correct node version to the environment. - Check if you have `mkdocs` installed locally (it requires Python). You can find installation instructions here: https://www.mkdocs.org/user-guide/installation/ ### Steps: - Install the dependencies `npm install` - `npm run build` - this will generate the '/material' folder with the compiled theme (you need to re-run this if you add assets) - `npm run start` - leave this running in a terminal, it will watch for code changes and rebuild the content (but not the assets) - `npm run serve` - will launch a dev server at 127.0.0.1:8000 with the current theme, it has hot reload (not very precise, sometimes you need to hard refresh the page) > If you wish to set the context to see other products information, you need to set the `product` config in the `mkdocs.yml` file in the project's root directory. The dev server should automatically reload and you will see the changes in the browser. ### Reminders: - The 'material' directory generated by the `npm run build` is the one used in the documentation, so please don't forget running the build once you finish all the changes. TODO: add git hooks and run build on pre-push. %package help Summary: Development documents and examples for mkdocs-traefiklabs Provides: python3-mkdocs-traefiklabs-doc %description help
A Traefik Labs Material Design theme for MkDocs
## Quick start Material for MkDocs can be installed with `pip`: ```sh pip install mkdocs-traefiklabs ``` Add the following line to `mkdocs.yml`: ```yaml theme: name: traefik-labs ``` ## How to run the project in Dev mode ### Pre-requisites - Check your node version, the .nvmrc file mentions the expected version. If you use nvm, you can run `nvm use` to set the correct node version to the environment. - Check if you have `mkdocs` installed locally (it requires Python). You can find installation instructions here: https://www.mkdocs.org/user-guide/installation/ ### Steps: - Install the dependencies `npm install` - `npm run build` - this will generate the '/material' folder with the compiled theme (you need to re-run this if you add assets) - `npm run start` - leave this running in a terminal, it will watch for code changes and rebuild the content (but not the assets) - `npm run serve` - will launch a dev server at 127.0.0.1:8000 with the current theme, it has hot reload (not very precise, sometimes you need to hard refresh the page) > If you wish to set the context to see other products information, you need to set the `product` config in the `mkdocs.yml` file in the project's root directory. The dev server should automatically reload and you will see the changes in the browser. ### Reminders: - The 'material' directory generated by the `npm run build` is the one used in the documentation, so please don't forget running the build once you finish all the changes. TODO: add git hooks and run build on pre-push. %prep %autosetup -n mkdocs-traefiklabs-100.0.19 %build %py3_build %install %py3_install install -d -m755 %{buildroot}/%{_pkgdocdir} if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi pushd %{buildroot} if [ -d usr/lib ]; then find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst fi if [ -d usr/lib64 ]; then find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst fi if [ -d usr/bin ]; then find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst fi if [ -d usr/sbin ]; then find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst fi touch doclist.lst if [ -d usr/share/man ]; then find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst fi popd mv %{buildroot}/filelist.lst . mv %{buildroot}/doclist.lst . %files -n python3-mkdocs-traefiklabs -f filelist.lst %dir %{python3_sitelib}/* %files help -f doclist.lst %{_docdir}/* %changelog * Tue Jun 20 2023 Python_Bot