diff options
author | CoprDistGit <infra@openeuler.org> | 2023-06-20 04:55:07 +0000 |
---|---|---|
committer | CoprDistGit <infra@openeuler.org> | 2023-06-20 04:55:07 +0000 |
commit | 5e6cad9aea2d3d1e41ed4578155a74e792450f37 (patch) | |
tree | cdf583f6087dc3e45b63b13dff3bf7774c1a1ac2 | |
parent | ee724ce71baa2f546a39621ec45a068a652a7328 (diff) |
automatic import of python-mkdocs-blog-pluginopeneuler20.03
-rw-r--r-- | .gitignore | 1 | ||||
-rw-r--r-- | python-mkdocs-blog-plugin.spec | 453 | ||||
-rw-r--r-- | sources | 1 |
3 files changed, 455 insertions, 0 deletions
@@ -0,0 +1 @@ +/mkdocs-blog-plugin-0.25.tar.gz diff --git a/python-mkdocs-blog-plugin.spec b/python-mkdocs-blog-plugin.spec new file mode 100644 index 0000000..c80616c --- /dev/null +++ b/python-mkdocs-blog-plugin.spec @@ -0,0 +1,453 @@ +%global _empty_manifest_terminate_build 0 +Name: python-mkdocs-blog-plugin +Version: 0.25 +Release: 1 +Summary: Keeps a really simple blog section inside your MkDocs site. +License: MIT +URL: https://github.com/fmaida/mkdocs-blog-plugin +Source0: https://mirrors.aliyun.com/pypi/web/packages/a4/de/cd98844ffa535f3d56d78437ecdf0c351d486f91933683f926dfac15b149/mkdocs-blog-plugin-0.25.tar.gz +BuildArch: noarch + + +%description +| This plugin allows you to host a tiny blog + section in your MkDocs site. +| Move away, WordPress... well, not really. +How does it work ? +~~~~~~~~~~~~~~~~~~ +| It's quite simple. 90% of the work is already done by + MkDocs itself. +| Each time you will build your MkDocs site or serve it, + this plugin will try to find a specific directory + in your documentation folder. + If it finds it, every document and every subdirectory + nested in it will be listed in reverse on the navbar. + Plus, if you will have too many documents to be listed + at once, the plugin will try to organize your remaining + documents in subfolders. +How can I install it ? +~~~~~~~~~~~~~~~~~~~~~~ +| You can install it through pip with this + command: + pip install mkdocs-blog-plugin +| Then, open your ``mkdocs.yml`` configuration + file and add these lines: + plugins: + - blog +| Last but not least, enter you ``docs`` folder + and create a new subfolder and name it ``blog``. + This plugin will try to find blog articles + inside this directory. +Then you are ready to begin. +How can I add new articles to my blog section ? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +| Inside ``docs/blog`` create a folder for each + year you are planning to add new articles. + Then, inside each year folder create twelve + folders, numbered from ``01`` to ``12`` for each + month. Finally, in each month folder for each day + create a corresponding folder but remember to add + a leading zero (for example: ``08``, ``09``, ``10``, ...) + Now, for every article you will go inside + the corresponding \`year/month/day folder and you + will create a new file there. + While it is not necessary that you keep this + strict naming convention, this will help the plugin + to understand when your article was made. +| For example, this is how I manage my blog folder: + docs + ├── blog + │ ├── 2019 + │ └── 2020 + │ ├── 01 + │ │ ├── 20 + │ │ │ └── first-article.md + │ │ └── 26 + │ │ └── second-article.md + │ ├── 02 + │ │ ├── 01 + │ │ │ └── third_article.md + │ │ └── 09 + │ │ └── fourth-article.md + │ └── 03 + │ └── 16 + │ └── fifth-article.md + └── index.md +Customizing the plugins +~~~~~~~~~~~~~~~~~~~~~~~ +| You can customize this plugin by adding some parameters + in the ``mkdocs.yml`` file, like this: + - plugin: + - blog: + format: "(%m/%d/%y)" + text-align: "right" +| Here is a brief list of every parameters supported + by the current version of the plugin: +folder +^^^^^^ +| This is the section / folder in which we'll try to + build our blog + Default value: "blog" +articles +^^^^^^^^ +| How many articles do we have to display on our blog + at once? More articles will be displayed in the + corresponding subsection + Default value: 6 articles +more-articles +^^^^^^^^^^^^^ +| Let's allow our user to slightly customize the + "previous articles" section. How do we have to name + this section if it will contains more articles? + Remember to put a percentage character wherever you + want this plugin to insert the number of available + articles. + Default value: "More articles (%)" +pagination +^^^^^^^^^^ +| Which name do we have to give to each subsection + inside our "more articles" section? + Remember to put two percentage characters wherever you + want this plugin to insert the actual number page and + the total amount of pages made. + Default value: Page % of %" +display-more-articles +^^^^^^^^^^^^^^^^^^^^^ +| Can we display the previous articles section, or is it + better if we hide it? + Default: True +display-article-date +^^^^^^^^^^^^^^^^^^^^ +| Can we display the article date in the navbar, or is it + better if we hide it? + Default: True +format +^^^^^^ +| How we have to display an article publication date on + our navbar? +| You can use these placeholders inside your string: +- ``%d`` = Day +- ``%m`` = Month +- ``%y`` = Year (2-digits) +- ``%Y`` = Year (4-digits) +| + Default value: "[%d/%m]" +text-align +^^^^^^^^^^ +| Do we have to display an article publication date on + the left side (``"left"``) or on the right side + (``"right"``)? + Default value: "left" + +%package -n python3-mkdocs-blog-plugin +Summary: Keeps a really simple blog section inside your MkDocs site. +Provides: python-mkdocs-blog-plugin +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-mkdocs-blog-plugin +| This plugin allows you to host a tiny blog + section in your MkDocs site. +| Move away, WordPress... well, not really. +How does it work ? +~~~~~~~~~~~~~~~~~~ +| It's quite simple. 90% of the work is already done by + MkDocs itself. +| Each time you will build your MkDocs site or serve it, + this plugin will try to find a specific directory + in your documentation folder. + If it finds it, every document and every subdirectory + nested in it will be listed in reverse on the navbar. + Plus, if you will have too many documents to be listed + at once, the plugin will try to organize your remaining + documents in subfolders. +How can I install it ? +~~~~~~~~~~~~~~~~~~~~~~ +| You can install it through pip with this + command: + pip install mkdocs-blog-plugin +| Then, open your ``mkdocs.yml`` configuration + file and add these lines: + plugins: + - blog +| Last but not least, enter you ``docs`` folder + and create a new subfolder and name it ``blog``. + This plugin will try to find blog articles + inside this directory. +Then you are ready to begin. +How can I add new articles to my blog section ? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +| Inside ``docs/blog`` create a folder for each + year you are planning to add new articles. + Then, inside each year folder create twelve + folders, numbered from ``01`` to ``12`` for each + month. Finally, in each month folder for each day + create a corresponding folder but remember to add + a leading zero (for example: ``08``, ``09``, ``10``, ...) + Now, for every article you will go inside + the corresponding \`year/month/day folder and you + will create a new file there. + While it is not necessary that you keep this + strict naming convention, this will help the plugin + to understand when your article was made. +| For example, this is how I manage my blog folder: + docs + ├── blog + │ ├── 2019 + │ └── 2020 + │ ├── 01 + │ │ ├── 20 + │ │ │ └── first-article.md + │ │ └── 26 + │ │ └── second-article.md + │ ├── 02 + │ │ ├── 01 + │ │ │ └── third_article.md + │ │ └── 09 + │ │ └── fourth-article.md + │ └── 03 + │ └── 16 + │ └── fifth-article.md + └── index.md +Customizing the plugins +~~~~~~~~~~~~~~~~~~~~~~~ +| You can customize this plugin by adding some parameters + in the ``mkdocs.yml`` file, like this: + - plugin: + - blog: + format: "(%m/%d/%y)" + text-align: "right" +| Here is a brief list of every parameters supported + by the current version of the plugin: +folder +^^^^^^ +| This is the section / folder in which we'll try to + build our blog + Default value: "blog" +articles +^^^^^^^^ +| How many articles do we have to display on our blog + at once? More articles will be displayed in the + corresponding subsection + Default value: 6 articles +more-articles +^^^^^^^^^^^^^ +| Let's allow our user to slightly customize the + "previous articles" section. How do we have to name + this section if it will contains more articles? + Remember to put a percentage character wherever you + want this plugin to insert the number of available + articles. + Default value: "More articles (%)" +pagination +^^^^^^^^^^ +| Which name do we have to give to each subsection + inside our "more articles" section? + Remember to put two percentage characters wherever you + want this plugin to insert the actual number page and + the total amount of pages made. + Default value: Page % of %" +display-more-articles +^^^^^^^^^^^^^^^^^^^^^ +| Can we display the previous articles section, or is it + better if we hide it? + Default: True +display-article-date +^^^^^^^^^^^^^^^^^^^^ +| Can we display the article date in the navbar, or is it + better if we hide it? + Default: True +format +^^^^^^ +| How we have to display an article publication date on + our navbar? +| You can use these placeholders inside your string: +- ``%d`` = Day +- ``%m`` = Month +- ``%y`` = Year (2-digits) +- ``%Y`` = Year (4-digits) +| + Default value: "[%d/%m]" +text-align +^^^^^^^^^^ +| Do we have to display an article publication date on + the left side (``"left"``) or on the right side + (``"right"``)? + Default value: "left" + +%package help +Summary: Development documents and examples for mkdocs-blog-plugin +Provides: python3-mkdocs-blog-plugin-doc +%description help +| This plugin allows you to host a tiny blog + section in your MkDocs site. +| Move away, WordPress... well, not really. +How does it work ? +~~~~~~~~~~~~~~~~~~ +| It's quite simple. 90% of the work is already done by + MkDocs itself. +| Each time you will build your MkDocs site or serve it, + this plugin will try to find a specific directory + in your documentation folder. + If it finds it, every document and every subdirectory + nested in it will be listed in reverse on the navbar. + Plus, if you will have too many documents to be listed + at once, the plugin will try to organize your remaining + documents in subfolders. +How can I install it ? +~~~~~~~~~~~~~~~~~~~~~~ +| You can install it through pip with this + command: + pip install mkdocs-blog-plugin +| Then, open your ``mkdocs.yml`` configuration + file and add these lines: + plugins: + - blog +| Last but not least, enter you ``docs`` folder + and create a new subfolder and name it ``blog``. + This plugin will try to find blog articles + inside this directory. +Then you are ready to begin. +How can I add new articles to my blog section ? +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +| Inside ``docs/blog`` create a folder for each + year you are planning to add new articles. + Then, inside each year folder create twelve + folders, numbered from ``01`` to ``12`` for each + month. Finally, in each month folder for each day + create a corresponding folder but remember to add + a leading zero (for example: ``08``, ``09``, ``10``, ...) + Now, for every article you will go inside + the corresponding \`year/month/day folder and you + will create a new file there. + While it is not necessary that you keep this + strict naming convention, this will help the plugin + to understand when your article was made. +| For example, this is how I manage my blog folder: + docs + ├── blog + │ ├── 2019 + │ └── 2020 + │ ├── 01 + │ │ ├── 20 + │ │ │ └── first-article.md + │ │ └── 26 + │ │ └── second-article.md + │ ├── 02 + │ │ ├── 01 + │ │ │ └── third_article.md + │ │ └── 09 + │ │ └── fourth-article.md + │ └── 03 + │ └── 16 + │ └── fifth-article.md + └── index.md +Customizing the plugins +~~~~~~~~~~~~~~~~~~~~~~~ +| You can customize this plugin by adding some parameters + in the ``mkdocs.yml`` file, like this: + - plugin: + - blog: + format: "(%m/%d/%y)" + text-align: "right" +| Here is a brief list of every parameters supported + by the current version of the plugin: +folder +^^^^^^ +| This is the section / folder in which we'll try to + build our blog + Default value: "blog" +articles +^^^^^^^^ +| How many articles do we have to display on our blog + at once? More articles will be displayed in the + corresponding subsection + Default value: 6 articles +more-articles +^^^^^^^^^^^^^ +| Let's allow our user to slightly customize the + "previous articles" section. How do we have to name + this section if it will contains more articles? + Remember to put a percentage character wherever you + want this plugin to insert the number of available + articles. + Default value: "More articles (%)" +pagination +^^^^^^^^^^ +| Which name do we have to give to each subsection + inside our "more articles" section? + Remember to put two percentage characters wherever you + want this plugin to insert the actual number page and + the total amount of pages made. + Default value: Page % of %" +display-more-articles +^^^^^^^^^^^^^^^^^^^^^ +| Can we display the previous articles section, or is it + better if we hide it? + Default: True +display-article-date +^^^^^^^^^^^^^^^^^^^^ +| Can we display the article date in the navbar, or is it + better if we hide it? + Default: True +format +^^^^^^ +| How we have to display an article publication date on + our navbar? +| You can use these placeholders inside your string: +- ``%d`` = Day +- ``%m`` = Month +- ``%y`` = Year (2-digits) +- ``%Y`` = Year (4-digits) +| + Default value: "[%d/%m]" +text-align +^^^^^^^^^^ +| Do we have to display an article publication date on + the left side (``"left"``) or on the right side + (``"right"``)? + Default value: "left" + +%prep +%autosetup -n mkdocs-blog-plugin-0.25 + +%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-blog-plugin -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Jun 20 2023 Python_Bot <Python_Bot@openeuler.org> - 0.25-1 +- Package Spec generated @@ -0,0 +1 @@ +5adcac5df0cca033a4d8e583c7189563 mkdocs-blog-plugin-0.25.tar.gz |