Merge pull request #16 from contentlayerdev/changesets

WIP 0.0.28

Author: schickling

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@1.6.1/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "linked": [["@contentlayer/*", "contentlayer", "next-contentlayer"]],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": ["examples-*"]
+}

.github/workflows/ci.yml

@@ -12,49 +12,29 @@ jobs:
         os: [ubuntu-latest]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: true
-      - uses: actions/setup-node@v1
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: yarn
-      - run: yarn install
+      - uses: schickling-actions/checkout-and-install@main
       - run: yarn lint:check
 
   test:
     strategy:
       matrix:
         node-version: [16.x]
+        # Note tests are currently not run in Windows because the path seperator on Windows invalidates the test results 🙈
         os: [ubuntu-latest]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: true
-      - uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: yarn
-      - run: yarn install
+      - uses: schickling-actions/checkout-and-install@main
       - run: yarn build
       - run: yarn test
 
   build-example-starter:
     strategy:
       matrix:
         node-version: [16.x]
-        os: [ubuntu-latest]
+        os: [ubuntu-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: true
-      - uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: yarn
-      - run: yarn install
+      - uses: schickling-actions/checkout-and-install@main
       - run: yarn build
       - run: yarn build
         working-directory: examples/starter
@@ -63,17 +43,10 @@ jobs:
     strategy:
       matrix:
         node-version: [16.x]
-        os: [ubuntu-latest]
+        os: [ubuntu-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: true
-      - uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: yarn
-      - run: yarn install
+      - uses: schickling-actions/checkout-and-install@main
       - run: yarn build
       - run: yarn build
         working-directory: examples/playground-azimuth
@@ -82,17 +55,10 @@ jobs:
     strategy:
       matrix:
         node-version: [16.x]
-        os: [ubuntu-latest]
+        os: [ubuntu-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: true
-      - uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: yarn
-      - run: yarn install
+      - uses: schickling-actions/checkout-and-install@main
       - run: yarn build
       - run: yarn build
         working-directory: examples/gatsby-docs
@@ -101,17 +67,10 @@ jobs:
     strategy:
       matrix:
         node-version: [16.x]
-        os: [ubuntu-latest]
+        os: [ubuntu-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: true
-      - uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: yarn
-      - run: yarn install
+      - uses: schickling-actions/checkout-and-install@main
       - run: yarn build
       - run: yarn build
         working-directory: examples/mdx

infra/jaeger/collector-config.yaml .infra/jaeger/collector-config.yamlinfra/jaeger/collector-config.yaml renamed to .infra/jaeger/collector-config.yaml

@@ -1,8 +1,9 @@
-// import rehypeShiki from '@leafac/rehype-shiki'
-// import { createRequire } from 'module'
+import rehypeShiki from '@stefanprobst/rehype-shiki'
+
+import { createRequire } from 'module'
 import { defineDocumentType, makeSource, defineNestedType, FieldDef } from 'contentlayer/source-files'
-// import * as path from 'path'
-// import * as shiki from 'shiki'
+import * as path from 'path'
+import * as shiki from 'shiki'
 
 const Example = defineNestedType(() => ({
   name: 'Example',
@@ -55,22 +56,19 @@ const Tutorial = defineDocumentType(() => ({
 }))
 
 export default makeSource(async () => {
-  // TODO re-enable once this is fixed https://github.com/leafac/rehype-shiki/issues/2
-
-  // const require = createRequire(import.meta.url)
-  // const shikiPath = (dir: string) => path.join(require.resolve('shiki'), '..', '..', dir, path.sep)
-  // const highlighter = await shiki.getHighlighter({
-  //   paths: { languages: shikiPath('languages'), themes: shikiPath('themes') },
-  //   theme: 'github-light',
-  // })
+  const require = createRequire(import.meta.url)
+  const shikiPkgPath = (dir: string) => path.join(require.resolve('shiki'), '..', '..', dir, path.sep)
+  const highlighter = await shiki.getHighlighter({
+    paths: { languages: shikiPkgPath('languages'), themes: shikiPkgPath('themes') },
+    theme: 'github-light',
+  })
 
   return {
     contentDirPath: 'gatsby/docs',
-    // contentDirPath: path.join(process.cwd(), 'gatsby', 'docs'),
     documentTypes: [Reference, HowTo, Conceptual, Tutorial],
     onUnknownDocuments: 'skip-ignore',
     markdown: {
-      // rehypePlugins: [[rehypeShiki as any, { highlighter }]],
+      rehypePlugins: [[rehypeShiki, { highlighter }]],
     },
   }
 })

infra/jaeger/docker-compose.yml .infra/jaeger/docker-compose.ymlinfra/jaeger/docker-compose.yml renamed to .infra/jaeger/docker-compose.yml

@@ -7,18 +7,19 @@
     "start": "next start"
   },
   "dependencies": {
-    "next": "^11.1.2",
+    "next": "^12.0.2",
     "react": "^17.0.2",
     "react-dom": "^17.0.2"
   },
   "devDependencies": {
     "@leafac/rehype-shiki": "^1.3.1",
+    "@stefanprobst/rehype-shiki": "^2.0.4",
     "@types/react": "^17.0.21",
     "@types/react-dom": "^17.0.9",
     "contentlayer": "workspace:*",
     "eslint-config-next": "^11.0.1",
     "next-contentlayer": "workspace:*",
     "shiki": "^0.9.4",
-    "typescript": "^4.4.3"
+    "typescript": "^4.4.4"
   }
-}
+}

examples/gatsby-docs/contentlayer.config.ts

@@ -0,0 +1,6 @@
+## Usage
+
+```sh
+curl https://codeload.github.com/contentlayerdev/contentlayer/tar.gz/main | \
+  tar -xz --strip=2 contentlayer-main/examples/mdx
+```