glen/mkdocs-semiliterate
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases 11 Wiki Activity

chore: Update to mkdocs-simple-plugin v1.0
All checks were successful
continuous-integration/drone Build is passing
Details

Browse source 
Also updates from pep517.build to the `build` package, and bumps the
  semiliterate version number.
  Resolves #14.
This commit is contained in:
Glen Whitney 2021-08-24 10:58:55 -07:00
parent f458f716e3
commit b4a49b67b8
21 changed files with 219 additions and 153 deletions
Download patch file Download diff file Expand all files Collapse all files

12
tests/fixtures/full-inclusion/refsite/404.html → tests/fixtures/full-inclusion/refsite/404.html.cropped vendored
View file

@ -7,17 +7,8 @@
<link rel="shortcut icon" href="/img/favicon.ico">
<title>Full inclusion</title>
<link href="/css/bootstrap.min.css" rel="stylesheet">
<link href="/css/font-awesome.min.css" rel="stylesheet">
<link href="/css/base.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">
<script src="/js/jquery-1.10.2.min.js" defer></script>
<script src="/js/bootstrap.min.js" defer></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body>
@ -52,11 +43,8 @@
<hr>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<script>
var base_url = "/",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
</script>
<script src="/js/base.js" defer></script>
<div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
<div class="modal-dialog">

5
tests/fixtures/full-inclusion/refsite/css/base.css vendored
View file

@ -311,3 +311,8 @@ h1:hover .headerlink, h2:hover .headerlink, h3:hover .headerlink, h4:hover .head
margin-left: 10px;
}
}
@media print {
/* Remove sidebar when print */
.col-md-3 { display: none; }
}

13
tests/fixtures/full-inclusion/refsite/croppedindex.html → tests/fixtures/full-inclusion/refsite/index.html.cropped vendored
View file

@ -7,17 +7,8 @@
<meta name="description" content="None">
<link rel="shortcut icon" href="img/favicon.ico">
<title>Full inclusion</title>
<link href="css/bootstrap.min.css" rel="stylesheet">
<link href="css/font-awesome.min.css" rel="stylesheet">
<link href="css/base.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">
<script src="js/jquery-1.10.2.min.js" defer></script>
<script src="js/bootstrap.min.js" defer></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="homepage">
@ -67,11 +58,8 @@
<hr>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<script>
var base_url = ".",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
</script>
<script src="js/base.js" defer></script>
<div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
<div class="modal-dialog">
@ -118,3 +106,4 @@
</html>
<!--
-->

12
tests/fixtures/git-inclusion/refsite/404.html → tests/fixtures/git-inclusion/refsite/404.html.cropped vendored
View file

@ -7,17 +7,8 @@
<link rel="shortcut icon" href="/img/favicon.ico">
<title>Full inclusion</title>
<link href="/css/bootstrap.min.css" rel="stylesheet">
<link href="/css/font-awesome.min.css" rel="stylesheet">
<link href="/css/base.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">
<script src="/js/jquery-1.10.2.min.js" defer></script>
<script src="/js/bootstrap.min.js" defer></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body>
@ -52,11 +43,8 @@
<hr>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<script>
var base_url = "/",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
</script>
<script src="/js/base.js" defer></script>
<div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
<div class="modal-dialog">

5
tests/fixtures/git-inclusion/refsite/css/base.css vendored
View file

@ -311,3 +311,8 @@ h1:hover .headerlink, h2:hover .headerlink, h3:hover .headerlink, h4:hover .head
margin-left: 10px;
}
}
@media print {
/* Remove sidebar when print */
.col-md-3 { display: none; }
}

13
tests/fixtures/git-inclusion/refsite/croppedindex.html → tests/fixtures/git-inclusion/refsite/index.html.cropped vendored
View file

@ -7,17 +7,8 @@
<meta name="description" content="None">
<link rel="shortcut icon" href="img/favicon.ico">
<title>Full inclusion</title>
<link href="css/bootstrap.min.css" rel="stylesheet">
<link href="css/font-awesome.min.css" rel="stylesheet">
<link href="css/base.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">
<script src="js/jquery-1.10.2.min.js" defer></script>
<script src="js/bootstrap.min.js" defer></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="homepage">
@ -75,11 +66,8 @@ docs_dir: mkdocs_semiliterate # dummy</p>
<hr>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<script>
var base_url = ".",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
</script>
<script src="js/base.js" defer></script>
<div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
<div class="modal-dialog">
@ -126,3 +114,4 @@ docs_dir: mkdocs_semiliterate # dummy</p>
</html>
<!--
-->

12
tests/fixtures/quoted-filename/refsite/404.html → tests/fixtures/quoted-filename/refsite/404.html.cropped vendored
View file

@ -7,17 +7,8 @@
<link rel="shortcut icon" href="/img/favicon.ico">
<title>Full inclusion</title>
<link href="/css/bootstrap.min.css" rel="stylesheet">
<link href="/css/font-awesome.min.css" rel="stylesheet">
<link href="/css/base.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">
<script src="/js/jquery-1.10.2.min.js" defer></script>
<script src="/js/bootstrap.min.js" defer></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body>
@ -52,11 +43,8 @@
<hr>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<script>
var base_url = "/",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
</script>
<script src="/js/base.js" defer></script>
<div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
<div class="modal-dialog">

5
tests/fixtures/quoted-filename/refsite/css/base.css vendored
View file

@ -311,3 +311,8 @@ h1:hover .headerlink, h2:hover .headerlink, h3:hover .headerlink, h4:hover .head
margin-left: 10px;
}
}
@media print {
/* Remove sidebar when print */
.col-md-3 { display: none; }
}

13
tests/fixtures/quoted-filename/refsite/croppedindex.html → tests/fixtures/quoted-filename/refsite/index.html.cropped vendored
View file

@ -7,17 +7,8 @@
<meta name="description" content="None">
<link rel="shortcut icon" href="img/favicon.ico">
<title>Full inclusion</title>
<link href="css/bootstrap.min.css" rel="stylesheet">
<link href="css/font-awesome.min.css" rel="stylesheet">
<link href="css/base.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">
<script src="js/jquery-1.10.2.min.js" defer></script>
<script src="js/bootstrap.min.js" defer></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="homepage">
@ -67,11 +58,8 @@
<hr>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<script>
var base_url = ".",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
</script>
<script src="js/base.js" defer></script>
<div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
<div class="modal-dialog">
@ -118,3 +106,4 @@
</html>
<!--
-->

2
tests/fixtures/recursive-inclusion/baz.qux vendored
View file

@ -2,7 +2,7 @@ I'd like you to know that
really just about anything can go up here.
START right here, because everything else on this line is ignored:
| file
in{! xyzzy extract: {start: '(.*)'} !}ion
in{! xyzzy {extract: {start: '(.*)'}, ensurelines: false} !}ion
STOP that distraction!
Now we can get back to our originally
scheduled qux.

1
tests/fixtures/recursive-inclusion/foo.bar vendored
View file

@ -15,6 +15,7 @@ And other features, such as extraction resumption.
Not to mention{! baz.qux extract:
start: START
replace: ['^\|(.*)$']
ensurelines: false
terminate: STOP !}syntax and `{! escaped syntax !}`.
---

1
tests/fixtures/recursive-inclusion/mkdocs.yml vendored
View file

@ -8,6 +8,7 @@ plugins:
semiliterate:
- pattern: '(\.bar)$'
extract: {start: '---', stop: '---'}
ensurelines: false
terminate: '!!!'
nav:
- About: README.md

12
tests/fixtures/recursive-inclusion/refsite/404.html → tests/fixtures/recursive-inclusion/refsite/404.html.cropped vendored
View file

@ -7,17 +7,8 @@
<link rel="shortcut icon" href="/img/favicon.ico">
<title>Custom semiliterate</title>
<link href="/css/bootstrap.min.css" rel="stylesheet">
<link href="/css/font-awesome.min.css" rel="stylesheet">
<link href="/css/base.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">
<script src="/js/jquery-1.10.2.min.js" defer></script>
<script src="/js/bootstrap.min.js" defer></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body>
@ -65,11 +56,8 @@
<hr>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<script>
var base_url = "/",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
</script>
<script src="/js/base.js" defer></script>
<div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
<div class="modal-dialog">

5
tests/fixtures/recursive-inclusion/refsite/css/base.css vendored
View file

@ -311,3 +311,8 @@ h1:hover .headerlink, h2:hover .headerlink, h3:hover .headerlink, h4:hover .head
margin-left: 10px;
}
}
@media print {
/* Remove sidebar when print */
.col-md-3 { display: none; }
}

12
tests/fixtures/recursive-inclusion/refsite/foo/index.html → tests/fixtures/recursive-inclusion/refsite/foo/index.html.cropped vendored
View file

@ -7,17 +7,8 @@
<link rel="shortcut icon" href="../img/favicon.ico">
<title>Details - Custom semiliterate</title>
<link href="../css/bootstrap.min.css" rel="stylesheet">
<link href="../css/font-awesome.min.css" rel="stylesheet">
<link href="../css/base.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">
<script src="../js/jquery-1.10.2.min.js" defer></script>
<script src="../js/bootstrap.min.js" defer></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body>
@ -91,11 +82,8 @@ syntax and <code>{! escaped syntax !}</code>.</p></div>
<hr>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<script>
var base_url = "..",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
</script>
<script src="../js/base.js" defer></script>
<div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
<div class="modal-dialog">

13
tests/fixtures/recursive-inclusion/refsite/croppedindex.html → tests/fixtures/recursive-inclusion/refsite/index.html.cropped vendored
View file

@ -7,17 +7,8 @@
<meta name="description" content="None">
<link rel="shortcut icon" href="img/favicon.ico">
<title>Custom semiliterate</title>
<link href="css/bootstrap.min.css" rel="stylesheet">
<link href="css/font-awesome.min.css" rel="stylesheet">
<link href="css/base.css" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">
<script src="js/jquery-1.10.2.min.js" defer></script>
<script src="js/bootstrap.min.js" defer></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="homepage">
@ -88,11 +79,8 @@
<hr>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<script>
var base_url = ".",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
</script>
<script src="js/base.js" defer></script>
<div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
<div class="modal-dialog">
@ -139,3 +127,4 @@
</html>
<!--
-->

11
tests/sites.bash
View file

@ -1,12 +1,17 @@
set -e
shopt -s globstar
startdir=$PWD
for file in tests/fixtures/*
do
cd "$startdir/$file"
mkdocs -v build
# unfortunately MkDocs writes the run date in the last few lines of index:
head -n -3 site/index.html > site/croppedindex.html
rm site/index.html
# unfortunately MkDocs writes the run date in the last few lines of index
# and has version numbers in some of the scripts that are irrelevant:
for hml in **/*.html
do
grep -v MkDocs.version $hml | grep -v Build.Date.UTC | grep -v '[</]script[ >]' | grep -v '[</]link' > "$hml.cropped"
rm $hml
done
diff -r -x img -x fonts -x js -x '*.xml*' refsite site
echo "Site in $file built successfully"
rm -r site