Merge docs -> main (#1393)

* fix (#1391) * fix transformers docs about ttypescript and ts-patch (#1392) * Better favicon, and fix url / baseUrl / "canonical" metadata (#1402)
TypeStrong · Aug 8, 2021 · 7819066 · 7819066
1 parent b044e71
commit 7819066
Show file tree

Hide file tree

Showing 16 changed files with 93 additions and 5 deletions.
diff --git a/website/docs/compilers.md b/website/docs/compilers.md
@@ -6,14 +6,16 @@ Some projects require a patched typescript compiler which adds additional featur
 add the ability to configure custom transformers.  These are drop-in replacements for the vanilla `typescript` module and
 implement the same API.
 
-For example, to use `ts-patch` and `ts-transformer-keys`, add this to your `tsconfig.json`:
+For example, to use `ttypescript` and `ts-transformer-keys`, add this to your `tsconfig.json`:
 
 ```json title="tsconfig.json"
 {
   "ts-node": {
-    "compiler": "ts-patch"
+    // This can be omitted when using ts-patch
+    "compiler": "ttypescript"
   },
   "compilerOptions": {
+    // plugin configuration is the same for both ts-patch and ttypescript
     "plugins": [
       { "transform": "ts-transformer-keys/transformer" }
     ]

diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -1,11 +1,11 @@
 module.exports = {
   title: 'ts-node',
   tagline: 'TypeScript execution and REPL for node.js',
-  url: 'https://typestrong.org/ts-node',
+  url: 'https://typestrong.org',
   baseUrl: '/ts-node/',
   onBrokenLinks: 'throw',
   onBrokenMarkdownLinks: 'warn',
-  favicon: 'img/favicon.ico',
+  favicon: 'img/favicon/favicon.ico',
   organizationName: 'TypeStrong', // Usually your GitHub org/user name.
   projectName: 'ts-node', // Usually your repo name.
   themeConfig: {

diff --git a/website/readme-sources/license.md b/website/readme-sources/license.md
@@ -2,7 +2,7 @@
 title: License
 ---
 
-[MIT](https://github.com/TypeStrong/ts-node/blob/main/LICENSE)
+ts-node is licensed under the MIT license.  [MIT](https://github.com/TypeStrong/ts-node/blob/main/LICENSE)
 
 ts-node includes source code from Node.js which is licensed under the MIT license.  [Node.js license information](https://raw.githubusercontent.com/nodejs/node/master/LICENSE)
 

diff --git a/website/src/pages/index.js b/website/src/pages/index.js
@@ -2,6 +2,7 @@ import React from 'react';
 import clsx from 'clsx';
 import Layout from '@theme/Layout';
 import Link from '@docusaurus/Link';
+import Head from '@docusaurus/Head';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import useBaseUrl from '@docusaurus/useBaseUrl';
 import styles from './styles.module.css';
@@ -26,6 +27,17 @@ function Home() {
     <Layout
       title={siteConfig.title}
       description={siteConfig.tagline}>
+      <Head>
+        <link rel="apple-touch-icon" sizes="180x180" href="/ts-node/img/favicon/apple-touch-icon.png"/>
+        <link rel="icon" type="image/png" sizes="32x32" href="/ts-node/img/favicon/favicon-32x32.png"/>
+        <link rel="icon" type="image/png" sizes="16x16" href="/ts-node/img/favicon/favicon-16x16.png"/>
+        <link rel="manifest" href="/ts-node/img/favicon/site.webmanifest"/>
+        <link rel="mask-icon" href="/ts-node/img/favicon/safari-pinned-tab.svg" color="#5bbad5"/>
+        <link rel="shortcut icon" href="/ts-node/img/favicon/favicon.ico"/>
+        <meta name="msapplication-TileColor" content="#2b5797"/>
+        <meta name="msapplication-config" content="/ts-node/img/favicon/browserconfig.xml"/>
+        <meta name="theme-color" content="#ffffff"/>
+      </Head>
       <header className={clsx('hero hero--primary', styles.heroBanner)}>
         <div className="container">
           <h1 className="hero__title">{siteConfig.title}</h1>

diff --git a/website/static/img/favicon/android-chrome-192x192.png b/website/static/img/favicon/android-chrome-192x192.png
diff --git a/website/static/img/favicon/android-chrome-512x512.png b/website/static/img/favicon/android-chrome-512x512.png
diff --git a/website/static/img/favicon/apple-touch-icon.png b/website/static/img/favicon/apple-touch-icon.png
diff --git a/website/static/img/favicon/browserconfig.xml b/website/static/img/favicon/browserconfig.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<browserconfig>
+    <msapplication>
+        <tile>
+            <square150x150logo src="/ts-node/img/mstile-150x150.png"/>
+            <TileColor>#2b5797</TileColor>
+        </tile>
+    </msapplication>
+</browserconfig>
diff --git a/website/static/img/favicon/favicon-16x16.png b/website/static/img/favicon/favicon-16x16.png
diff --git a/website/static/img/favicon/favicon-32x32.png b/website/static/img/favicon/favicon-32x32.png
diff --git a/website/static/img/favicon/favicon.ico b/website/static/img/favicon/favicon.ico
diff --git a/website/static/img/favicon/html_code.html b/website/static/img/favicon/html_code.html
@@ -0,0 +1,19 @@
+<link rel="apple-touch-icon" sizes="180x180" href="/ts-node/img/apple-touch-icon.png">
+<link rel="icon" type="image/png" sizes="32x32" href="/ts-node/img/favicon-32x32.png">
+<link rel="icon" type="image/png" sizes="16x16" href="/ts-node/img/favicon-16x16.png">
+<link rel="manifest" href="/ts-node/img/site.webmanifest">
+<link rel="mask-icon" href="/ts-node/img/safari-pinned-tab.svg" color="#5bbad5">
+<link rel="shortcut icon" href="/ts-node/img/favicon.ico">
+<meta name="msapplication-TileColor" content="#2b5797">
+<meta name="msapplication-config" content="/ts-node/img/browserconfig.xml">
+<meta name="theme-color" content="#ffffff">
+
+<link rel="apple-touch-icon" sizes="180x180" href="/ts-node/img/favicon/apple-touch-icon.png">
+<link rel="icon" type="image/png" sizes="32x32" href="/ts-node/img/favicon/favicon-32x32.png">
+<link rel="icon" type="image/png" sizes="16x16" href="/ts-node/img/favicon/favicon-16x16.png">
+<link rel="manifest" href="/ts-node/img/favicon/site.webmanifest">
+<link rel="mask-icon" href="/ts-node/img/favicon/safari-pinned-tab.svg" color="#5bbad5">
+<link rel="shortcut icon" href="/ts-node/img/favicon/favicon.ico">
+<meta name="msapplication-TileColor" content="#2b5797">
+<meta name="msapplication-config" content="/ts-node/img/favicon/browserconfig.xml">
+<meta name="theme-color" content="#ffffff">
diff --git a/website/static/img/favicon/mstile-150x150.png b/website/static/img/favicon/mstile-150x150.png
diff --git a/website/static/img/favicon/safari-pinned-tab.svg b/website/static/img/favicon/safari-pinned-tab.svg
diff --git a/website/static/img/favicon/site.webmanifest b/website/static/img/favicon/site.webmanifest
@@ -0,0 +1,19 @@
+{
+    "name": "",
+    "short_name": "",
+    "icons": [
+        {
+            "src": "/ts-node/img/android-chrome-192x192.png",
+            "sizes": "192x192",
+            "type": "image/png"
+        },
+        {
+            "src": "/ts-node/img/android-chrome-512x512.png",
+            "sizes": "512x512",
+            "type": "image/png"
+        }
+    ],
+    "theme_color": "#ffffff",
+    "background_color": "#ffffff",
+    "display": "standalone"
+}
diff --git a/website/static/img/opengraph.pdn b/website/static/img/opengraph.pdn