wip: state

.babelrc

@@ -1,11 +1,13 @@
 {
   "presets": [
-    ["@babel/preset-env", { "targets": { "node": "current" } }],
     [
-      "@babel/preset-react",
+      "@babel/preset-env",
       {
-        "runtime": "automatic"
+        "targets": {
+          "node": "current"
+        }
       }
-    ]
+    ],
+    "@babel/preset-react"
   ]
 }

.eslintrc.json

@@ -7,17 +7,13 @@
   "env": {
     "browser": true,
     "es2021": true,
-    "node": true,
-    "jest": true
-  },
-  "globals": {
-    "jest": true
+    "node": true
   },
   "extends": [
     "eslint:recommended",
     "plugin:react/recommended",
     "plugin:mdx/recommended",
-    "plugin:jest/recommended"
+    "plugin:react-hooks/recommended"
   ],
   "parserOptions": {
     "ecmaFeatures": {

.github/workflows/test.yml

@@ -24,15 +24,7 @@ jobs:
         run: yarn install --frozen-lockfile
 
       - name: Lint Code Base
-        uses: github/[email protected]
-        env:
-          LINTER_RULES_PATH: /
-          LOG_LEVEL: 'WARN'
-          JAVASCRIPT_ES_CONFIG_FILE: .eslintrc.json
-          VALIDATE_JAVASCRIPT_STANDARD: false
-          FILTER_REGEX_EXCLUDE: .*husky.*|README.md
-          DEFAULT_BRANCH: main
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: yarn lint
 
       - name: Test
         run: yarn test

.gitignore

@@ -6,7 +6,7 @@
 .pnp.js
 
 # testing
-/coverage
+coverage
 
 # next.js
 /.next/

.npmignore

@@ -0,0 +1,12 @@
+test
+.prettierrc
+.babelrc
+src
+.eslint*
+.github
+coverage
+setupTests.js
+assets
+.husky
+.stylelintrc.json
+rollup.config.js  

README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <img src="assets/opstrace-docs.png">
+  <img src=".github/assets/opstrace-docs.png">
 </p>
 
 <p align="center">
@@ -68,14 +68,18 @@ or check out the
 
 In your Next.js website repo, run:
 
-    yarn add @opstrace/next-product-docs
+    npm install @zentered/next-product-docs
 
 or
 
-    npm install @opstrace/next-product-docs
+    yarn add @zentered/next-product-docs
 
 The location of your product docs can be configured through environment
-variables in your `.env` file:
+variables in your `.env` file. There are two possible ways to retrieve docs:
+
+### Retrieve docs from GitHub Repo
+
+ie. `github.com/zentered/next-product-docs-example/main`
 
 ```
 GITHUB_TOKEN=
@@ -84,9 +88,25 @@ DOCS_ORG=zentered
 DOCS_REPO=next-product-docs-example
 DOCS_BRANCH=main
 DOCS_FALLBACK=README
+DOCS_SKIP_PATH_PREFIX=false
 ASSETS_DESTINATION=/assets
 ```
 
+### Retrieve docs from local docs folder
+
+ie. `./content/docs`:
+
+```
+DOCS_PATH=content
+DOCS_FOLDER=docs
+DOCS_FALLBACK=README
+ASSETS_DESTINATION=
+```
+
+### Other options
+
+- `DOCS_USE_MDX`
+
 Create a new page `pages/docs/[[...slug]].jsx` which calls the provided
 `staticPaths` and `pageProps` functions:
 
@@ -122,13 +142,21 @@ export async function getStaticProps(ctx) {
 
 # Run Locally
 
+## Setup
+
 ```bash
-    npm run watch
-    # or yarn watch
-```
+    # build dist folder
+    pnpm build
+
+    # create system-wide link to project folder
+    pnpm link .
 
-Read how to link component in
-[next-product-docs-example](https://github.com/zentered/next-product-docs-example)
+    # in the website/next project folder
+    pnpm link @zentered/next-product-docs ../next-product-docs
+
+    # for continous monitoring in next-product-docs
+    pnpm watch
+```
 
 ## Additional Components
 
@@ -145,6 +173,19 @@ using `react-scroll` to highlight the current section of the page in the table
 of contents. In the sidebar you can easily integrate search for example with
 [Algolia React InstantSearch](https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/react/).
 
+### Code Import
+
+You can import code from external files:
+
+```js file=./examples/hello.js
+
+```
+
+This only works when working with a local folder, not by fetching the docs from
+a remote repository. Check out
+[remark-code-import](https://github.com/kevin940726/remark-code-import) for
+further information.
+
 ## Contributing
 
 Considering contributing to next-product-docs? We'd love to work with you!
@@ -156,7 +197,7 @@ on how to link/unlink the component in a Next.js project.
 Please join us for
 [discussions in our community](https://go.opstrace.com/community).
 
-You can also ping us on Twitter [@opstrace](http://twitter.com/opstrace) or
+You can also ping us on Twitter [@zentered](http://twitter.com/opstrace) or
 [@zenteredco](http://twitter.com/zenteredco). The only workaround we have at the
 moment is forking the repository, publish new package versions to GitHub and
 install them in the Next.js project where we use the component.

index.js

@@ -1 +1 @@
-module.exports = require('./dist/index')
+export * from './dist/index.js'