Changes

2024-05-11 00:55:44 -04:00 · 2020-05-09 13:33:22 +03:00 · 2020-05-09 13:33:22 +03:00 · deb9aaf70e
parent d491d4094d
commit deb9aaf70e
8 changed files with 155 additions and 27 deletions
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@ -0,0 +1,18 @@
+name: Publish docs via GitHub Pages
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout master
+        uses: actions/checkout@v1
+
+      - name: Deploy docs
+        uses: fpscan/mkdocs-deploy-gh-pages@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
--- a/.gitignore
+++ b/.gitignore
@ -1,2 +1,2 @@
-site/
+/site
 .DS_Store
--- a/README.md
+++ b/README.md
@ -1,11 +1,3 @@
-# Libretro Documentation
+# Libretro Docs

-This is the source for the [libretro documentation](https://docs.libretro.com), powered by [MkDocs](http://www.mkdocs.org/).
-
-[MkDocs documentation](http://www.mkdocs.org/)
-
-[Material for MkDocs documentation](https://squidfunk.github.io/mkdocs-material/)
-
-[Contributing guide](https://docs.libretro.com/meta/how-to-contribute/)
-
-![travis](https://www.travis-ci.org/libretro/docs.svg?branch=master)
+WIP
--- a/custom_theme/main.html
+++ b/custom_theme/main.html
@ -1,11 +0,0 @@
-{% extends "base.html" %}
-
-{% block extrahead %}
-<script async src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
-<script>
-     (adsbygoogle = window.adsbygoogle || []).push({
-          google_ad_client: "ca-pub-9447404270680650",
-          enable_page_level_ads: true
-     });
-</script>
-{% endblock %}
--- a/docs/CNAME
+++ b/docs/CNAME
@ -0,0 +1 @@
+docs.libretro.com
--- a/mkdocs.yml
+++ b/mkdocs.yml
@ -1,8 +1,11 @@
 site_name: Libretro Docs
-site_url: 'http://docs.libretro.com/'
+site_url: 'https://docs.libretro.com'
+site_description: >-
+  This is RetroArch's document page, modification or development information outside of this repo may be incorrect.
 repo_name: 'libretro/docs'
 repo_url: 'https://github.com/libretro/docs'
 edit_uri: 'edit/master/docs'
+copyright: Copyright &copy; 2010 <a href="https://libretro.com">Libretro</a>
 nav:
  - 'About': 'index.md'
  - 'For Users':
@ -21,8 +24,8 @@ nav:
      - 'Sony':
        - 'PlayStation Portable': 'guides/install-psp.md'
        - 'PlayStation Vita': 'guides/install-psv.md'
-        - 'PlayStation2': 'guides/install-ps2.md'
-        - 'PlayStation3': 'guides/install-ps3.md'
+        - 'PlayStation 2': 'guides/install-ps2.md'
+        - 'PlayStation 3': 'guides/install-ps3.md'
      - 'Others':
        - 'Lakka-PC': 'guides/install-lakka.md' 
        - 'Steam Link': 'guides/install-steamlink.md' 
@ -346,15 +349,69 @@ extra:
  palette:
    primary: 'blue'
    accent:  'blue'
+  social:
+    - icon: fontawesome/brands/github-alt
+      link: https://github.com/libretro
+    - icon: fontawesome/brands/twitter
+      link: https://twitter.com/libretro
+    - icon: fontawesome/brands/facebook
+      link: https://facebook.com/libretro
+    - icon: fontawesome/brands/youtube
+      link: https://youtube.com/libretro         
+  disqus: retroarch
+
 theme:
-  name: 'readthedocs'
-  custom_dir: 'custom_theme'
+  name: 'material'
+  custom_dir: overrides
+  include_search_page: false
+  search_index_only: true
+  language: en
+  features:
+    - tabs
+    #- instant
+  palette:
+    primary: indigo
+    accent: indigo
+  font:
+    text: Roboto
+    code: Roboto Mono
  logo: 'image/branding/invader.png'
  favicon: 'image/branding/invader.png'
+
 markdown_extensions:
  - markdown.extensions.admonition
  - markdown.extensions.codehilite:
      linenums: true
+      guess_lang: false
+  - markdown.extensions.def_list
+  - markdown.extensions.footnotes
+  - markdown.extensions.meta   
  - markdown.extensions.nl2br
  - markdown.extensions.toc:
      permalink: true
+  - pymdownx.arithmatex
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.critic
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_index: !!python/name:materialx.emoji.twemoji
+      emoji_generator: !!python/name:materialx.emoji.to_svg
+  # - pymdownx.highlight:
+  #     linenums_style: pymdownx-inline
+  - pymdownx.inlinehilite
+  - pymdownx.keys
+  - pymdownx.magiclink:
+      repo_url_shorthand: true
+      user: libretro
+      repo: docs
+  - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.snippets:
+      check_paths: true
+  - pymdownx.superfences
+  - pymdownx.tabbed
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
--- a/overrides/main.html
+++ b/overrides/main.html
@ -0,0 +1,44 @@
+{#-
+  This file was automatically generated - do not edit
+-#}
+{% extends "base.html" %}
+{% block extrahead %}
+  {% set title = config.site_name %}
+  {% if page and page.title and not page.is_homepage %}
+    {% set title = config.site_name ~ " - " ~ page.title | striptags %}
+  {% endif %}
+  {% set image = config.site_url ~ 'assets/images/banner.png' %}
+  <meta property="og:type" content="website">
+  <meta property="og:title" content="{{ title }}">
+  <meta property="og:description" content="{{ config.site_description }}">
+  <meta property="og:url" content="{{ page.canonical_url }}">
+  <meta property="og:image" content="{{ image }}">
+  <meta property="og:image:type" content="image/png">
+  <meta property="og:image:width" content="1200">
+  <meta property="og:image:height" content="630">
+  <meta name="twitter:card" content="summary_large_image">
+  <meta name="twitter:site" content="@libretro">
+  <meta name="twitter:creator" content="@libretro">
+  <meta name="twitter:title" content="{{ title }}">
+  <meta name="twitter:description" content="{{ config.site_description }}">
+  <meta name="twitter:image" content="{{ image }}">
+{% endblock %}
+{% block announce %}
+  <style>.md-announce a,.md-announce a:focus,.md-announce a:hover{color:currentColor}.md-announce strong{white-space:nowrap}.md-announce .twitter{margin-left:.2em;color:#00acee}</style>
+  <a href="https://twitter.com/squidfunk">
+    For updates follow <strong>@libretro</strong> on
+    <span class="twemoji twitter">
+      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512">
+        <path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"></path>
+      </svg>
+    </span>
+    <strong>Twitter</strong>
+  </a>
+  <script async src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
+<script>
+     (adsbygoogle = window.adsbygoogle || []).push({
+          google_ad_client: "ca-pub-9447404270680650",
+          enable_page_level_ads: true
+     });
+</script>
+{% endblock %}
--- a/typings/lunr.d.ts
+++ b/typings/lunr.d.ts
@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2016-2020 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.
+ */
+
+import * as lunr from "lunr"
+
+declare global {
+  const lunr: typeof lunr
+}