diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 000000000..4709af5aa --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,47 @@ +name: Docs + +on: + push: + branches: + - master + paths: + - mkdocs.yml + - docs/** + - .github/workflows/docs.yml + +permissions: + contents: write + +jobs: + deploy: + name: Deploy + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v3 + + - name: Install Python + uses: actions/setup-python@v4 + with: + python-version: '3.11' + + - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV + + - uses: actions/cache@v3 + with: + key: mkdocs-material-${{ env.cache_id }} + path: .cache + restore-keys: | + mkdocs-material- + + - name: Install Python dependencies + run: pip install mkdocs-material==9.2.0b3 mkdocs-awesome-pages-plugin mkdocs-macros-plugin mkdocs-git-revision-date-localized-plugin mkdocs-glightbox + + - name: Patch blog dates to support datetimes + run: sed -i 's|date.fromisoformat|datetime.fromisoformat|' $(pip show mkdocs-material | grep Location | cut -d ' ' -f 2)/material/plugins/blog/plugin.py + + - name: Deploy to Github Pages + run: mkdocs gh-deploy --force + env: + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index d85f2f411..000000000 --- a/docs/.gitignore +++ /dev/null @@ -1,6 +0,0 @@ -_site -.sass-cache -.bundle -/vendor/ -/doxygen/html/ -/doxygen/xml/ \ No newline at end of file diff --git a/docs/Gemfile b/docs/Gemfile deleted file mode 100644 index 05cf1d4d8..000000000 --- a/docs/Gemfile +++ /dev/null @@ -1,13 +0,0 @@ -source "https://rubygems.org" -ruby RUBY_VERSION - -# Github pages -gem "github-pages", group: :jekyll_plugins - -# Jekyll plugins -group :jekyll_plugins do - gem "jekyll-feed", "~> 0.6" -end - -# Windows does not include zoneinfo files, so bundle the tzinfo-data gem -gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby] diff --git a/docs/_category/android.md b/docs/_category/android.md deleted file mode 100644 index 715f2b1df..000000000 --- a/docs/_category/android.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -tag: android ---- \ No newline at end of file diff --git a/docs/_category/linux.md b/docs/_category/linux.md deleted file mode 100644 index 59515bde0..000000000 --- a/docs/_category/linux.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -tag: linux ---- \ No newline at end of file diff --git a/docs/_category/release.md b/docs/_category/release.md deleted file mode 100644 index cd35c730e..000000000 --- a/docs/_category/release.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -tag: release ---- \ No newline at end of file diff --git a/docs/_config.yml b/docs/_config.yml deleted file mode 100644 index f56d9015c..000000000 --- a/docs/_config.yml +++ /dev/null @@ -1,73 +0,0 @@ -title: Imgbrd-Grabber -subtitle: Booru browsing made easy -description: Very customizable imageboard/booru browser and mass downloader, with powerful filenaming features. -logo: assets/img/icon.png -show_download: true -google_analytics: G-MR404DPTE5 -discord_url: https://discord.gg/pWnY5eW3rz -theme: -lang: en_US -relative_permalinks: false -baseurl: /imgbrd-grabber -excerpt_separator: -paginate: 5 -paginate_path: "/blog/page:num/" - -exclude: -- vendor/ -- release/ -- releases/ -- languages/ -- cli/ -- gui/ -- tests/ - -collections: - docs: - permalink: "/:collection/:path.html" - output: true - sources: - permalink: "/docs/:collection/:path.html" - output: true - posts: - permalink: "/blog/:year/:month/:day/:title.html" - output: true - category: - permalink: "/blog/:collection/:path.html" - output: true - -gems: - - jemoji - - jekyll-feed - - jekyll-paginate - - jekyll-sitemap - - jekyll-seo-tag - -webmaster_verifications: - google: HUsU9v5lhoPPeKdafhViSRi1NofQwzQrRwLN1nEzsA8 - -defaults: - - scope: - path: "" - values: - image: assets/img/icon.png - - scope: - path: _docs - type: docs - values: - layout: docs - - scope: - path: _sources - type: sources - values: - layout: sources - - scope: - path: _posts - type: post - values: - layout: blog_post - - scope: - path: _category - type: category - values: - layout: blog_category diff --git a/docs/_data/docs_navigation.yml b/docs/_data/docs_navigation.yml deleted file mode 100644 index 355878701..000000000 --- a/docs/_data/docs_navigation.yml +++ /dev/null @@ -1,48 +0,0 @@ -- name: Installation - children: - - link: /docs/install/windows.html - - link: /docs/install/linux.html - - link: /docs/install/macos.html - - link: /docs/install/android.html -- name: Basics - children: - - link: /docs/ - - link: /docs/filename.html - - link: /docs/search.html - - link: /docs/sources.html - - link: /docs/favorites.html - - link: /docs/website-login.html - - link: /docs/shortcuts.html - - link: /docs/faq.html -- name: Commands - children: - - link: /docs/commands/ - - link: /docs/commands/szurubooru.html - - link: /docs/commands/danbooru.html - - link: /docs/commands/my-imouto.html - - link: /docs/commands/gelbooru.html - - link: /docs/commands/shimmie.html -- name: Sources - children: - - link: /docs/sites/ - - link: /docs/sites/source.html - - link: /docs/sites/source-example.html - - link: /docs/sites/javascript-helper.html - - link: /docs/sites/source-registry.html -- name: Plugins - children: - - link: /docs/plugins/translation.html - - link: /docs/plugins/theme.html -- name: Tools - children: - - link: /docs/tools/blacklist-fixer.html - - link: /docs/tools/image-renamer.html - - link: /docs/tools/tag-loader.html -- name: Advanced - children: - - link: /docs/compilation.html - - link: /docs/cli.html - - link: /docs/metadata.html - - link: /docs/portable-version.html - - link: /docs/configuration-files.html - - link: /docs/telemetry.html \ No newline at end of file diff --git a/docs/_docs/sources.md b/docs/_docs/sources.md deleted file mode 100644 index db9bdca21..000000000 --- a/docs/_docs/sources.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Sources ---- - -## Sources - -{% include source_list.html %} \ No newline at end of file diff --git a/docs/_includes/blog.html b/docs/_includes/blog.html deleted file mode 100644 index bb7997961..000000000 --- a/docs/_includes/blog.html +++ /dev/null @@ -1,43 +0,0 @@ - -{%capture header %} -
{{ post.excerpt | replace: '
', ' ' | replace: '
', ' ' | strip }} - - - Read more - \ No newline at end of file diff --git a/docs/_includes/source_list.html b/docs/_includes/source_list.html deleted file mode 100644 index 62632d09c..000000000 --- a/docs/_includes/source_list.html +++ /dev/null @@ -1,7 +0,0 @@ -{{ site.subtitle }}
- {% endif %} -{{ site.description | default: site.github.project_tagline }}
- - {% if site.show_download %} - - {% endif %} - -