2024-11-28 05:48:34 +01:00
13 changed files with 54 additions and 83 deletions
--- a/.gitignore
+++ b/.gitignore
@ -2,4 +2,3 @@ _site
 .jekyll-cache
 obj
 .idea
-__*
--- a/README.md
+++ b/README.md
@ -1,5 +1,15 @@
 ![The Tiny Life banner](https://raw.githubusercontent.com/Ellpeck/TinyLifeWeb/main/docs/media/banner.png)

-This is the repository for the [Tiny Life website](https://tinylifegame.com), which you can find in the `web` directory, as well as the [Tiny Life Developer Docs](https://docs.tinylifegame.com), which you can find in the `docs` directory.
+Welcome to the Tiny Life Modding API! On [the site](https://docs.tinylifegame.com), you can find the full modding API documentation, a bunch of modding tutorials, as well as an online version of the game's changelog.

-Additional documentation for various parts of the game and its development can be found on [the wiki](https://wiki.tinylifegame.com), as well.
+# What next?
+- To install a mod, custom lot or custom household, check out the [custom content installation](https://docs.tinylifegame.com/articles/getting.html) tutorial.
+- To create your first mod, check out the [modding basics](https://docs.tinylifegame.com/articles/mod_basics.html) tutorial or the [example mod](https://github.com/Ellpeck/TinyLifeExampleMod).
+- This site features a web version of the modding API's [documentation](https://docs.tinylifegame.com/api/TinyLife.html) as well, which is a verbatim copy of the XML documentation that you can find in the API's source.
+
+# Contributing
+If you've made a mod for Tiny Life before, and you think you know what you're doing, you can help others by contributing your own tutorial articles or improving existing ones. You can get started doing so by [submitting a pull request](https://github.com/Ellpeck/TinyLifeWeb/pulls). 
+
+If you found an error in the game's API or its documentation, you can also [submit an issue](https://github.com/Ellpeck/TinyLifeWeb/issues).
+
+Thank you for supporting Tiny Life's custom content community!
--- a/docs/.htaccess
+++ b/docs/.htaccess
@ -3,10 +3,3 @@ ExpiresDefault A31536000
 ExpiresByType text/html A600
 ExpiresByType text/javascript A2592000
 ExpiresByType application/javascript A2592000
-
-RewriteEngine On
-RewriteBase /
-
-# legacy redirects
-RewriteRule ^Changelog(.html)?$ "https://tinylifegame.com/changelog" [R=301,L]
-RewriteRule ^InGameNews(.html)?$ "https://tinylifegame.com/ingamenews" [R=301,L]
--- a/docs/docfx.json
+++ b/docs/docfx.json
@ -9,6 +9,13 @@
                    "toc.yml",
                    "api/**.yml"
                ]
+            },
+            {
+                "files": [
+                    "Changelog.md",
+                    "InGameNews.md"
+                ],
+                "src": ".."
            }
        ],
        "resource": [
@ -17,10 +24,16 @@
                    "media/**",
                    ".htaccess"
                ]
+            },
+            {
+                "files": [
+                    "media/**"
+                ],
+                "src": ".."
            }
        ],
        "globalMetadata": {
-            "_appTitle": "Tiny Life Developer Docs",
+            "_appTitle": "Tiny Life Docs",
            "_appLogoPath": "media/logo.png",
            "_appFaviconPath": "media/favicon.ico",
            "_appFooter": "<a href=\"https://github.com/Ellpeck/TinyLifeWeb\">&copy; 2021-2024</a> <a href=\"https://games.ellpeck.de\">Ellpeck Games</a>, <a href=\"https://tophat.studio/\">Top Hat Studios</a> &ndash; <a href=\"https://ellpeck.de/impressum\">Impressum</a> &ndash; <a href=\"https://ellpeck.de/privacy\">Privacy</a> &ndash; <a href=\"https://status.ellpeck.de\">Status</a>",
--- a/docs/index.md
+++ b/docs/index.md
@ -1,12 +1,15 @@
 ![The Tiny Life banner](media/banner.png)

-Welcome to the Tiny Life Developer Docs! On here, you can find the full modding API documentation, as well as links to various modding tutorials and additional information to what you can find on [the wiki](https://wiki.tinylifegame.com).
+Welcome to the Tiny Life Modding API! On here, you can find the full modding API documentation, a bunch of modding tutorials, as well as an online version of the game's changelog.
+
+## What next?
+- To install a mod, custom lot or custom household, check out the [custom content installation](~/articles/getting.md) tutorial.
+- To create your first mod, check out the [modding basics](~/articles/mod_basics.md) tutorial or the [example mod](https://github.com/Ellpeck/TinyLifeExampleMod).
+- This site features a web version of the modding API's [documentation](xref:TinyLife) as well, which is a verbatim copy of the XML documentation that you can find in the API's source.

 ## Contributing
-If you found an error in the game's API or its documentation, please feel free to [submit an issue](https://github.com/Ellpeck/TinyLifeWeb/issues). 
+If you've made a mod for Tiny Life before, and you think you know what you're doing, you can help others by contributing your own tutorial articles or improving existing ones. You can get started doing so by [submitting a pull request](https://github.com/Ellpeck/TinyLifeWeb/pulls). If you do, please start out with a draft pull request so we can communicate about your plans for the content you're contributing.

-If you've made a mod for Tiny Life before, and you think you know what you're doing, you can help others by contributing your own tutorial articles or improving existing ones. You can get started doing so by [submitting a pull request](https://github.com/Ellpeck/TinyLifeWeb/pulls). If you do, please start out with a draft pull request, so we can communicate about your plans for the content you're contributing. 
+If you found an error in the game's API or its documentation, you can also [submit an issue](https://github.com/Ellpeck/TinyLifeWeb/issues).

-Please keep in mind that some content, especially information meant for all players (rather than just developers), may fit better on [the wiki](https://wiki.tinylifegame.com) than this site.
-
-Since the API documentation is generated automatically, the `docs/api` directory in the repository should not be edited through pull requests.
+Thank you for supporting Tiny Life's custom content community!
--- a/docs/toc.yml
+++ b/docs/toc.yml
@ -2,9 +2,11 @@
  href: https://tinylifegame.com
 - name: Wiki
  href: https://wiki.tinylifegame.com
- name: Docs Home
+- name: Home
  href: /
 - name: Tutorials
  href: articles/
 - name: API Documentation
  href: api/
+- name: Changelog
+  href: ../Changelog.md
--- a/web/Gemfile.lock
+++ b/web/Gemfile.lock
@ -9,6 +9,7 @@ GEM
      eventmachine (>= 0.12.9)
      http_parser.rb (~> 0)
    eventmachine (1.2.7)
+    eventmachine (1.2.7-x64-mingw32)
    ffi (1.15.5)
    forwardable-extended (2.6.0)
    google-protobuf (3.23.3)
@ -59,6 +60,8 @@ GEM
    safe_yaml (1.0.5)
    sass-embedded (1.63.4-x64-mingw-ucrt)
      google-protobuf (~> 3.23)
+    sass-embedded (1.63.4-x64-mingw32)
+      google-protobuf (~> 3.23)
    sass-embedded (1.63.4-x64-unknown)
      google-protobuf (~> 3.23)
    sass-embedded (1.63.4-x86_64-linux-gnu)
--- a/web/_includes/basicnav.html
+++ b/web/_includes/basicnav.html
@ -1 +0,0 @@
-<a class="nav-item nav-link" href="../../">🏠 Home</a>
--- a/web/_layouts/blog.html
+++ b/web/_layouts/blog.html
@ -11,6 +11,16 @@ nav: blognav.html
    }));
 </script>

+<style>
+    h1 .anchor-heading, h2 .anchor-heading, h3 .anchor-heading, h4 .anchor-heading, h5 .anchor-heading, h6 .anchor-heading {
+        visibility: hidden;
+    }
+
+    h1:hover .anchor-heading, h2:hover .anchor-heading, h3:hover .anchor-heading, h4:hover .anchor-heading, h5:hover .anchor-heading, h6:hover .anchor-heading {
+        visibility: visible;
+    }
+</style>
+
 <div class="section blog-section">
    <h1>{{ page.title }}</h1>
    <p>📖 You can also read this post <a href="{{ page.itch }}">on itch</a> or <a href="{{ page.steam }}">on Steam</a>, or you can subscribe to <a href="../../#subscribe">the mailing list</a> or <a href="/feed.xml">the Atom feed</a>.</p>
--- a/web/_plugins/copy_changelog_news.rb
+++ b/web/_plugins/copy_changelog_news.rb
@ -1,9 +0,0 @@
-# copy changelog and news to includes
-FileUtils.cp '../InGameNews.md', '_includes/__news.md'
-FileUtils.cp '../Changelog.md', '_includes/__changelog.md'
-
-# after the site is generated, copy changelog and news media into it
-Jekyll::Hooks.register :site, :post_write do
-    FileUtils.cp_r "../media/news", "_site/media"
-    FileUtils.cp_r "../media/changelog", "_site/media"
-end
--- a/web/changelog.html
+++ b/web/changelog.html
@ -1,15 +0,0 @@
---
-layout: default
-nav: basicnav.html
-title: Tiny Life Changelog
-summary: The full changelog for Tiny Life
---
-
-<div class="section isolated-site">
-    <h1>Tiny Life Changelog</h1>
-    <p>This is the full changelog for the game, as seen in the bottom-right corner of its main menu.</p>
-
-    {% capture changelog %}{% include __changelog.md %}{% endcapture %}
-    {% assign content = changelog | markdownify | replace: 'src="media/', 'src="../media/' %}
-    {% include anchor_headings.html html=content anchorBody="#" anchorClass="anchor-heading" %}
-</div>
--- a/web/ingamenews.html
+++ b/web/ingamenews.html
@ -1,20 +0,0 @@
---
-layout: default
-nav: basicnav.html
-title: Tiny Life In-Game News
-summary: Tiny Life's in-game news, but displayed on the web
---
-
-<div class="section isolated-site">
-    <h1>Tiny Life In-Game News</h1>
-    <p>This is a web version of the in-game news that sometimes appear in the bottom-left corner of the main menu.</p>
-
-    {% capture news %}{% include __news.md %}{% endcapture %}
-    {% assign content = news | markdownify | replace: 'src="media/', 'src="../media/' | strip %}
-    {% if content != "" %}
-        {% include anchor_headings.html html=content anchorBody="#" anchorClass="anchor-heading" %}
-    {% else %}
-        <p><i>There are no in-game news at the moment.</i></p>
-    {% endif %}
-
-</div>
--- a/web/style.css
+++ b/web/style.css
@ -1,12 +1,10 @@
 html {
    scroll-padding-top: 70px;
-    position: relative;
-    min-height: 100%;
 }

 body {
+    position: relative;
    font-family: "Lato", sans-serif;
-    margin-bottom: 100px;
 }

 h1, h2, h3, h4, h5, h6, .nav-item {
@ -65,8 +63,7 @@ a:visited.wide-link {
    margin-top: 70px;
 }

-.blog-section img,
-.isolated-site img {
+.blog-section img {
    width: 100%;
    height: auto;
 }
@ -148,12 +145,6 @@ a:visited.wide-link {
 .footer {
    text-align: center;
    padding: 15px;
-    position: absolute;
-    left: 0;
-    right: 0;
-    bottom: 0;
-    margin-left: auto;
-    margin-right: auto;
 }

 .devlog {
@ -231,18 +222,10 @@ a:visited.wide-link {
    font-style: italic;
 }

-.community-top, .isolated-site {
+.community-top {
    margin-top: 70px;
 }

-h1 .anchor-heading, h2 .anchor-heading, h3 .anchor-heading, h4 .anchor-heading, h5 .anchor-heading, h6 .anchor-heading {
-    visibility: hidden;
-}
-
-h1:hover .anchor-heading, h2:hover .anchor-heading, h3:hover .anchor-heading, h4:hover .anchor-heading, h5:hover .anchor-heading, h6:hover .anchor-heading {
-    visibility: visible;
-}
-
 body.dark-mode {
    color: #d8d8d8;
    background-color: #1b1b1b;
				`@ -1 +0,0 @@`
				`<a class="nav-item nav-link" href="../../">🏠 Home</a>`