Skip to content

Commit

Permalink
优化统计插件
Browse files Browse the repository at this point in the history
  • Loading branch information
@Cdm2883
Cdm2883 committed Sep 7, 2024
1 parent 45a3daa commit 5dde07b
Show file tree
Hide file tree
Showing 8 changed files with 210 additions and 9 deletions.
28 changes: 22 additions & 6 deletions .github/workflows/mkdocs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,34 @@ jobs:
build:
name: Deploy docs
runs-on: ubuntu-latest
# noinspection SpellCheckingInspection
steps:
- name: Checkout master
uses: actions/checkout@v1
with:
submodules: true
fetch-depth: 0

- name: Set PYTHONPATH
run: echo "PYTHONPATH=$GITHUB_WORKSPACE:$PYTHONPATH" >> $GITHUB_ENV

- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
REQUIREMENTS: requirements.txt
- name: Install local plugins
run: |
for dir in plugins/*; do
pip install -e "$dir"
done
- name: Install pip plugins
run: pip install -r requirements.txt

- name: Install Material for MkDocs
run: pip install mkdocs-material[recommended]

- name: Build docs
run: mkdocs build

- name: Deploy docs to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site
force_orphan: true
4 changes: 4 additions & 0 deletions .gitmodules
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[submodule "plugins/mkdocs-statistics-plugin"]
path = plugins/mkdocs-statistics-plugin
url = https://github.com/Cdm2883/mkdocs-statistics-plugin.git
branch = develop-1
2 changes: 1 addition & 1 deletion docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ hide:
# 博文列表

<blockquote style="transform: translateY(-30px)">
<p>约 {{ words }} 个字和 {{ codes }} 行代码。</p>
<p>共 {{ pages }} 篇文章，约 {{ words }} 个字和 {{ codes }} 行代码。</p>
</blockquote>
3 changes: 2 additions & 1 deletion mkdocs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,9 @@ plugins:
- tags:
tags_file: tags.md
- statistics:
page_statistics: false
page_read_time: false
page_template: ../overrides/page_statistics.html
include_path: ^posts[\\/].*
- # noinspection SpellCheckingInspection
git-revision-date-localized:
type: timeago
Expand Down
179 changes: 179 additions & 0 deletions overrides/blog-post.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,179 @@
<!--
Copyright (c) 2016-2024 Martin Donath <martin.donath@squidfunk.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.
-->
<!--suppress HtmlUnknownTarget -->

{% extends "main.html" %}

{% import "partials/nav-item.html" as item with context %}

<!-- Page content -->
{% block container %}
<div class="md-content md-content--post" data-md-component="content">

<!-- Sidebar -->
<div class="md-sidebar md-sidebar--post" data-md-component="sidebar" data-md-type="navigation">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner md-post">
<nav class="md-nav md-nav--primary">

<!-- Back to overview link -->
<div class="md-post__back">
<div class="md-nav__title md-nav__container">
<a href="{{ page.parent.url | url }}" class=" md-nav__link">
{% include ".icons/material/arrow-left.svg" %}
<span class="md-ellipsis">
{{ lang.t("blog.index") }}
</span>
</a>
</div>
</div>

<!-- Post authors -->
{% if page.authors %}
<div class="md-post__authors md-typeset">
{% for author in page.authors %}
<div class="md-profile md-post__profile">
<span class="md-author md-author--long">
<img src="{{ author.avatar | url }}" alt="{{ author.name }}" />
</span>
<span class="md-profile__description">
<strong>
{% if author.url %}
<a href="{{ author.url }}">{{ author.name }}</a>
{% else %}
{{ author.name }}
{% endif %}
</strong>
<br/>
{{ author.description }}
</span>
</div>
{% endfor %}
</div>
{% endif %}

<!-- Post metadata -->
<ul class="md-post__meta md-nav__list">
<li class="md-nav__item md-nav__item--section">
<div class="md-post__title">
<span class="md-ellipsis">
{{ lang.t("blog.meta") }}
</span>
</div>
<nav class="md-nav">
<ul class="md-nav__list">

<!-- Post date -->
<li class="md-nav__item">
<div class="md-nav__link">
{% include ".icons/material/calendar.svg" %}
<time
datetime="{{ page.config.date.created }}"
class="md-ellipsis"
>
{{- page.config.date.created | date -}}
</time>
</div>
</li>

<!-- Post date updated -->
{% if page.config.date.updated %}
<li class="md-nav__item">
<div class="md-nav__link">
{% include ".icons/material/calendar-clock.svg" %}
<time
datetime="{{ page.config.date.updated }}"
class="md-ellipsis"
>
{{- page.config.date.updated | date -}}
</time>
</div>
</li>
{% endif %}

<!-- Post categories -->
{% if page.categories %}
<li class="md-nav__item">
<div class="md-nav__link">
{% include ".icons/material/bookshelf.svg" %}
<span class="md-ellipsis">
{{ lang.t("blog.categories.in") }}
{% for category in page.categories %}
<a href="{{ category.url | url }}">
{{- category.title -}}
</a>
{%- if loop.revindex > 1 %}, {% endif -%}
{% endfor -%}
</span>
</div>
</li>
{% endif %}

<!-- Post words -->
{% if page.meta.statistics_page_words %}
<li class="md-nav__item">
<div class="md-nav__link">
{% include ".icons/material/text.svg" %}
<span class="md-ellipsis">全文共约 {{ page.meta.statistics_page_words }} 字</span>
</div>
</li>
{% endif %}

<!-- Post readtime -->
{% if page.config.readtime %}
{% set time = page.config.readtime %}
<li class="md-nav__item">
<div class="md-nav__link">
{% include ".icons/material/clock-outline.svg" %}
<span class="md-ellipsis">
{% if time == 1 %}
{{ lang.t("readtime.one") }}
{% else %}
{{ lang.t("readtime.other") | replace("#", time) }}
{% endif %}
</span>
</div>
</li>
{% endif %}

</ul>
</nav>
</li>
</ul>
</nav>

<!-- Table of contents, if integrated -->
{% if "toc.integrate" in features %}
{% include "partials/toc.html" %}
{% endif %}
</div>
</div>
</div>

<!-- Page content -->
<article class="md-content__inner md-typeset">
{% block content %}
{% include "partials/content.html" %}
{% endblock %}
</article>
</div>
{% endblock %}
Empty file added overrides/page_statistics.html
View file
Empty file.
1 change: 1 addition & 0 deletions plugins/mkdocs-statistics-plugin
Submodule mkdocs-statistics-plugin added at 941e8d
2 changes: 1 addition & 1 deletion requirements.txt
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
mkdocs-rss-plugin==1.15.0
mkdocs-statistics-plugin==0.1.3
# mkdocs-statistics-plugin==0.1.3
mkdocs-git-revision-date-localized-plugin==1.2.7
mkdocs-meta-descriptions-plugin==3.0.0

0 comments on commit 5dde07b

Please sign in to comment.