diff --git a/.drone.yml b/.drone.yml index a2001de..d88f20e 100644 --- a/.drone.yml +++ b/.drone.yml @@ -66,12 +66,13 @@ steps: # 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 - - diff -r -x img -x fonts -x js -x '*.gz' refsite site + - diff -r -x img -x fonts -x js -x '*.xml*' refsite site # ``` # All of the commands should succeed and none of the diffs should produce any # output. ### - rm -r site + - name: validate image: klakegg/html-proofer:latest volumes: @@ -79,6 +80,27 @@ steps: command: ['--url-ignore', 'https://fonts.gstatic.com', '--allow-hash-href', '--file-ignore', './site/404.html,/.*tests.*/'] + - name: pre_deploy + image: debian + commands: + - mv site semiliterate + when: + event: [promote] + target: [release] + + - name: deploy + image: appleboy/drone-scp + settings: + host: studioinfinity.org + user: bitnami + key: + from_secret: bitnami_key + target: /opt/bitnami/apps/wordpress/htdocs/ + source: semiliterate + when: + event: [promote] + target: [release] + ### develop # ### Contributing # diff --git a/.gitignore b/.gitignore index 46513b7..8d18c4b 100644 --- a/.gitignore +++ b/.gitignore @@ -125,6 +125,7 @@ venv.bak/ # mkdocs documentation /site +/semiliterate # mypy .mypy_cache/ @@ -140,3 +141,5 @@ dmypy.json # Cython debug symbols cython_debug/ +# Secrets +secrets.txt diff --git a/README.md b/README.md index e0c2da7..1616429 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,8 @@ Time and trends have not validated Knuth's original vision of "literate programm The mkdocs-simple-plugin goes a long way toward creating a semiliterate programming environment. However, in creating narrative documentation, it's very useful to be able to quote or incorporate content -- whether that be documentation blocks or code examples -- from one file into another. To satisfy that need, this `semiliterate` plugin extends (i.e, literally inherits from) the `simple` plugin and adds a syntax for such inclusion. -With a few other small ease-of-use tweaks (documented in the Usage section), this extended plugin aims to produce a lightweight but comprehensive semiliterate programming environment. The documentation site is, of course, produced by MkDocs using the semiliterate plugin. +With a few other small ease-of-use tweaks (documented in the [Usage](http://studioinfinity.org/semiliterate/mkdocs_semiliterate/plugin) section), +this extended plugin aims to produce a lightweight but comprehensive semiliterate programming environment. The [documentation site](http://studioinfinity.org/semiliterate) is, of course, produced by MkDocs using the semiliterate plugin. ## License diff --git a/mkdocs.yml b/mkdocs.yml index a3d5a0a..f1450b9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,7 +8,7 @@ plugins: - search - semiliterate: merge_docs_dir: false - ignore_folders: [build, dist, tests] + ignore_folders: [build, dist, tests, semiliterate] include_extensions: [LICENSE] report_docs_build: true extract_standard_markdown: diff --git a/tests/fixtures/recursive-inclusion/refsite/sitemap.xml b/tests/fixtures/recursive-inclusion/refsite/sitemap.xml deleted file mode 100644 index c1bdd5b..0000000 --- a/tests/fixtures/recursive-inclusion/refsite/sitemap.xml +++ /dev/null @@ -1,11 +0,0 @@ - - - None - 2021-01-09 - daily - - None - 2021-01-09 - daily - - \ No newline at end of file