gregberge / smooth-doc Goto Github PK
View Code? Open in Web Editor NEWReady to use documentation theme for Gatsby.
Home Page: https://smooth-doc.com
License: MIT License
Ready to use documentation theme for Gatsby.
Home Page: https://smooth-doc.com
License: MIT License
npm i on smooth-doc starter fails for me as it is dependant on sharp packages...
when i see the log it says that sharp has some installation scripts that download a tar file from Github...
my company doesn't allow me to connect to GitHub and we have our own package manager within...
is there any option how we can run smooth-doc with a local installation?
my docs folder has nested folder and i want to show that each folder should also show nested folders. so my question is it possible to to do thing kind of thing in smooth docs theme?
currently i have done till this and is shows only parent folders look "Messaging" i want to show nested folder of Messaging folder which is "virtual-numbers" so how can i do this?
Add support for .md files, in addition to .mdx.
Since the MDX format is quite new, most Markdown text editors (such as Typora) don't support it.
This would generally be useful for pages where you don't need to include any custom React components, which can be the majority of pages when you're writing basic documentation.
If I create a file docs/index.md
, it should automatically be served when loading /docs
.
Markdown is the foundation on which MDX is built, therefore it makes sense to support it :)
In the code below, the <pre>
tag enclosing the prism highlighted code won't receive proper styling.
<details>
<summary>Collapsible element</summary>
```jsx
console.log("hello")
```
</details>
The problem in this situation is that <pre>
is not a direct children of the <Article>
. For lack of a generic solution for all nested code blocks, I think you should try to replace with:
> pre, > summary > pre {
/* ... */
}
Can I integrate a blog into the website,
I was trying to add a gatsby plugin like gatsby-theme-blog
but I run into dependencies issues (regarding react-17...) and then it broke the rendering...
I'm migrating a jeckyll/github and my knowledge of react/gatsby is not very deep
What is the recomended approach to add a Blog to the website?
We are running Algolia on our own and therefore need to configure our own appId
when setting up search. I would propose to make this parameter configurable as well.
Allow "run your own" config for algolia as well.
more info here: https://docsearch.algolia.com/docs/run-your-own#integration
Hi @gregberge!
First of all, very great project! This template brings a lot of essential and effective features that I expect from modern documentation websites. I'm currently looking into porting the documentation for my own OSS project. Since I have almost no background with frontend frameworks, I might have a couple of noobie questions. I hope you don't mind π
My first immediate question is how I can add custom HTML to mdx
files. Currently, when I add <pre><code><span class="keyword">public</span></code></pre>
besides other content, I'm getting an error:
(I know there is code highlighting built-in, but I have a custom tool that can generate better results for C# code)
I guess/hope there's an easy way to make this work, but like I said: Gatsby, React, et al. are all very new to me.
Thanks in advance and keep up the good work!
<HeroActionList>
is missing, so the build would fail and the theme won't applied.
+++ pages/index.mdx
<HeroBody>
<HeroTitle>Your Smooth DOC setup is complete!</HeroTitle>
<HeroTeaser>Edit `pages/index.mdx` to personalize homepage.</HeroTeaser>
+ <HeroActionList>
<HeroAction>
<Button
variant="neutral"
forwardedAs="a"
href="/docs/"
>
Browse Docs
</Button>
</HeroAction>
</HeroActionList>
</HeroBody>
Follow the README instructions
The project would compile smoothly
After following the get started step, when I browse to the initial documentation page, there are code blocks in the headings (see screenshot)
Steps to reproduce the behavior:
Follow get started install.
Click Browse Docs button
Observe code blocks (see screenshot)
A clear and concise description of what you expected to happen.
Please provide a minimal repository on GitHub.
Issues without a reproduction link are likely to stall.
npx envinfo --system --binaries --npmPackages smooth-doc,gatsby,react,react-dom --markdown --clipboard
Paste the results here:
## System:
- OS: macOS 10.15.7
- CPU: (8) x64 Intel(R) Core(TM) i5-1038NG7 CPU @ 2.00GHz
- Memory: 73.74 MB / 16.00 GB
- Shell: 5.7.1 - /bin/zsh
## Binaries:
- Node: 12.18.0 - /usr/local/bin/node
- npm: 6.14.4 - /usr/local/bin/npm
## npmPackages:
- gatsby: ^2.15.18 => 2.24.77
- react: ^16.10.1 => 16.14.0
- react-dom: ^16.10.1 => 16.14.0
- smooth-doc: ^5.0.4 => 5.1.1
Short note: I've been reporting several issues lately, and forgot to show my appreciation for this project. I also discovered xstyles which looks super promising!
In production / build mode, accessing a docs page on mobile directly (without going through the homepage) shows a blank page.
Go here: https://use-gesture.netlify.app/docs/extras/ with a viewport width set to anything strictly under 768px.
The content of the page should show.
Note that this problem doesn't happen in development mode.
Here is a DOM extract in development mode (correct):
Here is a DOM extract in production mode (incorrect):
As you can see, the class passed to the content div
is incorrect in production mode (as they are the same as the sidebar). I wasn't able to trace down the problem.
This is a full-fleshed repo (that has code line highlights, and a properly working sidenav β see #17):
https://github.com/pmndrs/react-use-gesture/tree/master/documentation
But any out-of-the box updated repro with a correct 404 page (see #21) will show the same problem.
npx envinfo --system --binaries --npmPackages smooth-doc,gatsby,react,react-dom --markdown --clipboard
Paste the results here:
## System:
- OS: macOS 10.15.7
- CPU: (12) x64 Intel(R) Core(TM) i9-8950HK CPU @ 2.90GHz
- Memory: 99.66 MB / 32.00 GB
- Shell: 5.7.1 - /bin/zsh
## Binaries:
- Node: 12.18.4 - ~/.nvm/versions/node/v12.18.4/bin/node
- Yarn: 1.22.4 - /usr/local/bin/yarn
- npm: 6.14.6 - ~/.nvm/versions/node/v12.18.4/bin/npm
## npmPackages:
- gatsby: ^2.24.85 => 2.24.85
- react: ^17.0.1 => 17.0.1
- react-dom: ^17.0.1 => 17.0.1
- smooth-doc: ^5.1.1 => 5.1.1
First off thanks for this amazing starter @gregberge! it's really helped me get a docs site up quickly.
I've run into an issue if I upgrade Smooth Docs to v9. When running gatsby build
I get the following error:
I've done some debugging myself and narrowed it down to the following in gatsby-config.js:57
topLevelImportPaths: ['@xstyled/styled-components'],
If I remove this, it builds as expected albeit without some of the overridden styles. I don't know if this is a smooth-docs or xstyled issue so please let me know if I should raise this as an issue against xstyled instead.
Steps to reproduce the behavior:
Upgrade smooth-doc to ^9.0.0
Gatsby to build without errors.
Repro repo - https://github.com/xaviemirmon/smooth-doc-compile-error-repro
npx envinfo --system --binaries --npmPackages smooth-doc,gatsby,react,react-dom --markdown --clipboard
## System:
- OS: macOS 12.4
- CPU: (10) arm64 Apple M1 Pro
- Memory: 276.89 MB / 16.00 GB
- Shell: 5.8.1 - /bin/zsh
## Binaries:
- Node: 16.15.0 - /usr/local/bin/node
- Yarn: 1.22.19 - ~/.yarn/bin/yarn
- npm: 8.11.0 - /usr/local/bin/npm
## npmPackages:
- gatsby: ^4.18.0 => 4.18.0
- react: ^18.2.0 => 18.2.0
- react-dom: ^18.2.0 => 18.2.0
- smooth-doc: ^9.0.0 => 9.0.0
Hi,
Great project. I have started using it, but I have a question. if I were to add https://www.gatsbyjs.com/plugins/gatsby-remark-sequence/ what is the best way to include this plugin? Before smooth-doc or after?
It does not seem to pick up the content in mdx and does not transform it.
Any help with be greatly appreciated.
Sub navigation in sidebar
I think it will be great addition to this already awesome theme. This will let us group some articles inside some category inside the section.
Image has been attached for example
Maybe depth
can be added in frontmatter to achieve this.
Too much of nesting certainly sound cumbersome to maintian. But at least one more level would be awesome.
First of all, I'd like to say what a nice job you've done with smooth DOC. Really like, helpful utility, and I'm excited to get up-and-running with it. I feel like I'm super close, but am running into one issue. I'm sure it's something simple, but I'm having trouble figuring out exactly what the issue is.
I've created a new site following the "Getting Started" instructions. Everything worked fine, and it ran with no issues with the default setup. Then I added a couple of docs pages in the /docs
folder, and that's when things went wrong.
Steps to reproduce the behavior:
/pages/docs/code-review.mdx
with the following content:---
title: The Code Review Process
section: Code
---
# The Code Review Process
TODO
/pages/docs/coding-standards.mdx
with the following content:---
title: Coding Standards
section: Code
---
# Coding Standards
TODO
## JavaScript
TODO
## React
TODO
## Python
TODO
## Go
TODO
develop
task in the terminal (this is actually a secondary part of the issue, I was expecting these browser to show these new pages, as I could see the terminal process recognized that they were there, and it processed them, but when I manually refreshed the browser, nothing changed).I expected to see these two new pages displayed in the sidebar navigation, and be able to navigate to and view them.
After manually restarting the process (which runs without any errors) and refreshing my browser, I see the following error stack:
npx envinfo --system --binaries --npmPackages smooth-doc,gatsby,react,react-dom --markdown --clipboard
Paste the results here:
## System:
- OS: macOS 10.15.6
- CPU: (16) x64 Intel(R) Core(TM) i9-9980HK CPU @ 2.40GHz
- Memory: 715.18 MB / 32.00 GB
- Shell: 5.7.1 - /bin/zsh
## Binaries:
- Node: 12.19.0 - ~/.nvm/versions/node/v12.19.0/bin/node
- Yarn: 1.22.10 - /usr/local/bin/yarn
- npm: 6.14.8 - ~/.nvm/versions/node/v12.19.0/bin/npm
## npmPackages:
- gatsby: ^2.15.18 => 2.24.91
- react: ^16.10.1 => 16.14.0
- react-dom: ^16.10.1 => 16.14.0
- smooth-doc: ^5.0.4 => 5.2.0
Nav shows overflow for no reason on small resolutions.
The fix is pretty easy, commenting out this line fixes it:
The links at the bottom of a docs page that link to the page prior and after have no padding/margin between them so if the browser is narrowed, they get pushed together making them hard to read.
Make rather large names for the pages before and after and then shrink the browser until they collide.
Just add a little margin so there isn't a complete collision that makes it hard to differentiate.
"Introduction to Number" is one and "Finite, Countable and Uncountable Sets" is the next.
npx envinfo --system --binaries --npmPackages smooth-doc,gatsby,react,react-dom --markdown --clipboard
Ignored because the problem is just aesthetical and not technical
Hi there. First of all, thank you so much for the great project. I'm using smooth doc for an upcoming project and it suits my needs. However, I have a question. I'm adding blog pages to my docs site. Implementation wise, I just add them as normal pages under a new posts
directory. That works for the time being.
However, I'm trying to add a blog index page that lists down all the pages under that posts
directory, but I'm unable to do so. I can't query graphql from a an .mdx
file. I also tried to do it on createPage in gatsby-node.js, but it doesn't work either, because it seems like it doesn't fit the pageType
asked in PageWrapper.js
.
Is there any approach that I can take to reach this goal?
Thank you very much.
CONTRIBUTING.md seems to be copied from another project, and its instructions fail.
Running yarn lint
will fail since eslint-config-prettier been updated (separate issue here)
Changing the config so it works, throws 36756 problems
Also running yarn test
fails with Usage Error: Couldn't find a script named "test".
Steps to reproduce the behavior:
Fork or clone the repo,
Follow CONTRIBURING.md instructions and run yarn lint
and yarn test
Both commands should run, without errors.
npx envinfo --system --binaries --npmPackages smooth-doc,gatsby,react,react-dom --markdown --clipboard
Paste the results here:
## System:
- OS: Linux 5.4 Ubuntu 20.04.1 LTS (Focal Fossa)
- CPU: (12) x64 Intel(R) Core(TM) i7-9750H CPU @ 2.60GHz
- Memory: 1.56 GB / 7.77 GB
- Container: Yes
- Shell: 5.8 - /usr/bin/zsh
## Binaries:
- Node: 14.15.1 - ~/.nvm/versions/node/v14.15.1/bin/node
- Yarn: 2.4.1 - ~/.nvm/versions/node/v14.15.1/bin/yarn
- npm: 7.5.3 - ~/.nvm/versions/node/v14.15.1/bin/npm
Hello,
I am using smooth doc to set up document website.
My images are located under /pages/docs/doc-category/images/
I can import the image by import url from './images/myImage.png'
<img src={url} />
It works.
However, can I insert image like
![linkl](./images/myImage.png)
Thank you so much!
Install fails using below command:
Error returned:
info Creating new site from git:
https://github.com/gregberge/smooth-doc-starter.git
Cloning into 'website'...
remote: Enumerating objects: 16, done.
remote: Counting objects: 100% (16/16), done.
remote: Compressing objects: 100% (13/13), done.
remote: Total 16 (delta 1), reused 13 (delta 1), pack-reused 0
Receiving objects: 100% (16/16), 366.55 KiB | 296.00 KiB/s, done.
success Created starter directory layout
info Installing packages...
npm ERR! code ERESOLVE
npm ERR! ERESOLVE unable to resolve dependency tree
npm ERR!
npm ERR! While resolving: [email protected]
npm ERR! Found: [email protected]
npm ERR! node_modules/react
npm ERR! react@"^16.10.1" from the root project
npm ERR! peer react@"^16.4.2 || ^17.0.0" from [email protected]
npm ERR! node_modules/gatsby
npm ERR! gatsby@"^2.15.18" from the root project
npm ERR! peer gatsby@"^2.15.0" from [email protected]
npm ERR! node_modules/smooth-doc
npm ERR! smooth-doc@"^5.0.4" from the root project
npm ERR! 1 more (react-dom)
npm ERR!
npm ERR! Could not resolve dependency:
npm ERR! peer react@"^16.9.0 | ^17.0.0" from [email protected]
npm ERR! node_modules/smooth-doc
npm ERR! smooth-doc@"^5.0.4" from the root project
npm ERR!
npm ERR! Fix the upstream dependency conflict, or retry
npm ERR! this command with --force, or --legacy-peer-deps
npm ERR! to accept an incorrect (and potentially broken) dependency resolution.
npm ERR!
npm ERR! See /Users/wfabritius/.npm/eresolve-report.txt for a full report.
npm ERR! A complete log of this run can be found in:
ERROR
Command failed with exit code 1: npm install
Error: Command failed with exit code 1: npm install
- error.js:60 makeError
[21aee85bd6ee71e0]/[execa]/lib/error.js:60:11
- index.js:118 handlePromise
[21aee85bd6ee71e0]/[execa]/index.js:118:26
- task_queues:96 processTicksAndRejections
node:internal/process/task_queues:96:5
- init-starter.js:135 install
[21aee85bd6ee71e0]/[gatsby-cli]/lib/init-starter.js:135:7
- init-starter.js:202 clone
[21aee85bd6ee71e0]/[gatsby-cli]/lib/init-starter.js:202:3
- init-starter.js:343 initStarter
[21aee85bd6ee71e0]/[gatsby-cli]/lib/init-starter.js:343:5
- create-cli.js:460
[21aee85bd6ee71e0]/[gatsby-cli]/lib/create-cli.js:460:9
When using links in the ToC in the DocLayout, the page position is correct in the first clic but wrong on the second clic with the content being behind the top header.
When using gatsby build --prefix-paths
to serve the documentation website under a prefix such as /my-project/
, the previous/next links at the bottom of each page disappear.
Note that other types of navigation don't seem to be affected.
See https://www.gatsbyjs.com/docs/how-to/previews-deploys-hosting/path-prefix/
Steps to reproduce the behavior:
pathPrefix: "/hello"
to gatsby-config.js
gatsby build --prefix-paths
gatsby serve --prefix-paths
and navigate to http://localhost:8000/hello
The previous/next links should still appear, and have the expected prefix.
fwouts/smooth-doc-starter@master...fwouts:path-prefix-bug
Compare running:
yarn gatsby build && yarn gatsby serve # works fine
yarn gatsby build --prefix-paths && yarn gatsby serve --prefix-paths # no navigation
npx envinfo --system --binaries --npmPackages smooth-doc,gatsby,react,react-dom --markdown --clipboard
Paste the results here:
## System:
- OS: macOS 11.2.1
- CPU: (8) arm64 Apple M1
- Memory: 109.27 MB / 8.00 GB
- Shell: 5.8 - /bin/zsh
## Binaries:
- Node: 15.8.0 - /opt/homebrew/bin/node
- Yarn: 1.22.10 - /opt/homebrew/bin/yarn
- npm: 7.5.0 - /opt/homebrew/bin/npm
## npmPackages:
- gatsby: ^2.15.18 => 2.32.4
- react: ^16.10.1 => 16.14.0
- react-dom: ^16.10.1 => 16.14.0
- smooth-doc: ^5.0.4 => 5.5.0
Currently, It is unfeasible to change SEO descriptions of each individual pages, like meta description, og:description etc.
Description of each page is very necessary for SEO.
For example, pages like
https://smooth-doc.com/docs/write-mdx/
https://smooth-doc.com/docs/components/button/
etc.
may need separate description than "Ready to use documentation theme for Gatsby"
It is very important for Smooth DOC, as it is necessary for any document website to be good at SEO with precise meta descriptions of each page.
ERROR #11321 PLUGIN
"gatsby-plugin-mdx" threw an error while running the preprocessSource lifecycle:
Cannot read properties of undefined (reading 'setParserPlugins')
128 | }
129 |
130 | const mdxOptions = await (0, _pluginOptions.enhanceMdxOptions)(pluginOptions, {
| ^
131 | getNode,
132 | getNodesByType,
133 | pathPrefix,
File: node_modules\smooth-doc\node_modules\gatsby-plugin-mdx\dist\gatsby-node.js:130:65
TypeError: Cannot read properties of undefined (reading 'setParserPlugins')
plugin-options.js:70 enhanceMdxOptions
[kavach-docs]/[smooth-doc]/[gatsby-plugin-mdx]/dist/plugin-options.js:70:33
gatsby-node.js:130 Object.preprocessSource
[kavach-docs]/[smooth-doc]/[gatsby-plugin-mdx]/dist/gatsby-node.js:130:65
api-runner-node.js:485 runAPI
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:485:22
api-runner-node.js:636 Promise.catch.decorateEvent.pluginName
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:636:13
debuggability.js:384 Promise._execute
[kavach-docs]/[bluebird]/js/release/debuggability.js:384:9
promise.js:518 Promise._resolveFromExecutor
[kavach-docs]/[bluebird]/js/release/promise.js:518:18
promise.js:103 new Promise
[kavach-docs]/[bluebird]/js/release/promise.js:103:10
api-runner-node.js:634
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:634:16
util.js:16 tryCatcher
[kavach-docs]/[bluebird]/js/release/util.js:16:23
reduce.js:166 Object.gotValue
[kavach-docs]/[bluebird]/js/release/reduce.js:166:18
reduce.js:155 Object.gotAccum
[kavach-docs]/[bluebird]/js/release/reduce.js:155:25
util.js:16 Object.tryCatcher
[kavach-docs]/[bluebird]/js/release/util.js:16:23
promise.js:547 Promise._settlePromiseFromHandler
[kavach-docs]/[bluebird]/js/release/promise.js:547:31
promise.js:604 Promise._settlePromise
[kavach-docs]/[bluebird]/js/release/promise.js:604:18
promise.js:641 Promise._settlePromiseCtx
[kavach-docs]/[bluebird]/js/release/promise.js:641:10
async.js:97 _drainQueueStep
[kavach-docs]/[bluebird]/js/release/async.js:97:12
ERROR #11321 PLUGIN
"gatsby-plugin-mdx" threw an error while running the preprocessSource lifecycle:
Cannot read properties of undefined (reading 'setParserPlugins')
128 | }
129 |
130 | const mdxOptions = await (0, _pluginOptions.enhanceMdxOptions)(pluginOptions, {
| ^
131 | getNode,
132 | getNodesByType,
133 | pathPrefix,
File: node_modules\smooth-doc\node_modules\gatsby-plugin-mdx\dist\gatsby-node.js:130:65
TypeError: Cannot read properties of undefined (reading 'setParserPlugins')
plugin-options.js:70 enhanceMdxOptions
[kavach-docs]/[smooth-doc]/[gatsby-plugin-mdx]/dist/plugin-options.js:70:33
gatsby-node.js:130 Object.preprocessSource
[kavach-docs]/[smooth-doc]/[gatsby-plugin-mdx]/dist/gatsby-node.js:130:65
api-runner-node.js:485 runAPI
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:485:22
api-runner-node.js:636 Promise.catch.decorateEvent.pluginName
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:636:13
debuggability.js:384 Promise._execute
[kavach-docs]/[bluebird]/js/release/debuggability.js:384:9
promise.js:518 Promise._resolveFromExecutor
[kavach-docs]/[bluebird]/js/release/promise.js:518:18
promise.js:103 new Promise
[kavach-docs]/[bluebird]/js/release/promise.js:103:10
api-runner-node.js:634
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:634:16
util.js:16 tryCatcher
[kavach-docs]/[bluebird]/js/release/util.js:16:23
reduce.js:166 Object.gotValue
[kavach-docs]/[bluebird]/js/release/reduce.js:166:18
reduce.js:155 Object.gotAccum
[kavach-docs]/[bluebird]/js/release/reduce.js:155:25
util.js:16 Object.tryCatcher
[kavach-docs]/[bluebird]/js/release/util.js:16:23
promise.js:547 Promise._settlePromiseFromHandler
[kavach-docs]/[bluebird]/js/release/promise.js:547:31
promise.js:604 Promise._settlePromise
[kavach-docs]/[bluebird]/js/release/promise.js:604:18
promise.js:641 Promise._settlePromiseCtx
[kavach-docs]/[bluebird]/js/release/promise.js:641:10
async.js:97 _drainQueueStep
[kavach-docs]/[bluebird]/js/release/async.js:97:12
ERROR #11321 PLUGIN
"gatsby-plugin-mdx" threw an error while running the preprocessSource lifecycle:
Cannot read properties of undefined (reading 'setParserPlugins')
128 | }
129 |
130 | const mdxOptions = await (0, _pluginOptions.enhanceMdxOptions)(pluginOptions, {
| ^
131 | getNode,
132 | getNodesByType,
133 | pathPrefix,
File: node_modules\smooth-doc\node_modules\gatsby-plugin-mdx\dist\gatsby-node.js:130:65
TypeError: Cannot read properties of undefined (reading 'setParserPlugins')
plugin-options.js:70 enhanceMdxOptions
[kavach-docs]/[smooth-doc]/[gatsby-plugin-mdx]/dist/plugin-options.js:70:33
gatsby-node.js:130 Object.preprocessSource
[kavach-docs]/[smooth-doc]/[gatsby-plugin-mdx]/dist/gatsby-node.js:130:65
api-runner-node.js:485 runAPI
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:485:22
api-runner-node.js:636 Promise.catch.decorateEvent.pluginName
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:636:13
debuggability.js:384 Promise._execute
[kavach-docs]/[bluebird]/js/release/debuggability.js:384:9
promise.js:518 Promise._resolveFromExecutor
[kavach-docs]/[bluebird]/js/release/promise.js:518:18
promise.js:103 new Promise
[kavach-docs]/[bluebird]/js/release/promise.js:103:10
api-runner-node.js:634
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:634:16
util.js:16 tryCatcher
[kavach-docs]/[bluebird]/js/release/util.js:16:23
reduce.js:166 Object.gotValue
[kavach-docs]/[bluebird]/js/release/reduce.js:166:18
reduce.js:155 Object.gotAccum
[kavach-docs]/[bluebird]/js/release/reduce.js:155:25
util.js:16 Object.tryCatcher
[kavach-docs]/[bluebird]/js/release/util.js:16:23
promise.js:547 Promise._settlePromiseFromHandler
[kavach-docs]/[bluebird]/js/release/promise.js:547:31
promise.js:604 Promise._settlePromise
[kavach-docs]/[bluebird]/js/release/promise.js:604:18
promise.js:641 Promise._settlePromiseCtx
[kavach-docs]/[bluebird]/js/release/promise.js:641:10
async.js:97 _drainQueueStep
[kavach-docs]/[bluebird]/js/release/async.js:97:12
ERROR #11321 PLUGIN
"gatsby-plugin-mdx" threw an error while running the preprocessSource lifecycle:
Cannot read properties of undefined (reading 'setParserPlugins')
128 | }
129 |
130 | const mdxOptions = await (0, _pluginOptions.enhanceMdxOptions)(pluginOptions, {
| ^
131 | getNode,
132 | getNodesByType,
133 | pathPrefix,
File: node_modules\smooth-doc\node_modules\gatsby-plugin-mdx\dist\gatsby-node.js:130:65
TypeError: Cannot read properties of undefined (reading 'setParserPlugins')
plugin-options.js:70 enhanceMdxOptions
[kavach-docs]/[smooth-doc]/[gatsby-plugin-mdx]/dist/plugin-options.js:70:33
gatsby-node.js:130 Object.preprocessSource
[kavach-docs]/[smooth-doc]/[gatsby-plugin-mdx]/dist/gatsby-node.js:130:65
api-runner-node.js:485 runAPI
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:485:22
api-runner-node.js:636 Promise.catch.decorateEvent.pluginName
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:636:13
debuggability.js:384 Promise._execute
[kavach-docs]/[bluebird]/js/release/debuggability.js:384:9
promise.js:518 Promise._resolveFromExecutor
[kavach-docs]/[bluebird]/js/release/promise.js:518:18
promise.js:103 new Promise
[kavach-docs]/[bluebird]/js/release/promise.js:103:10
api-runner-node.js:634
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:634:16
util.js:16 tryCatcher
[kavach-docs]/[bluebird]/js/release/util.js:16:23
reduce.js:166 Object.gotValue
[kavach-docs]/[bluebird]/js/release/reduce.js:166:18
reduce.js:155 Object.gotAccum
[kavach-docs]/[bluebird]/js/release/reduce.js:155:25
util.js:16 Object.tryCatcher
[kavach-docs]/[bluebird]/js/release/util.js:16:23
promise.js:547 Promise._settlePromiseFromHandler
[kavach-docs]/[bluebird]/js/release/promise.js:547:31
promise.js:604 Promise._settlePromise
[kavach-docs]/[bluebird]/js/release/promise.js:604:18
promise.js:641 Promise._settlePromiseCtx
[kavach-docs]/[bluebird]/js/release/promise.js:641:10
async.js:97 _drainQueueStep
[kavach-docs]/[bluebird]/js/release/async.js:97:12
ERROR #11321 PLUGIN
"gatsby-plugin-mdx" threw an error while running the preprocessSource lifecycle:
Cannot read properties of undefined (reading 'setParserPlugins')
128 | }
129 |
130 | const mdxOptions = await (0, _pluginOptions.enhanceMdxOptions)(pluginOptions, {
| ^
131 | getNode,
132 | getNodesByType,
133 | pathPrefix,
File: node_modules\smooth-doc\node_modules\gatsby-plugin-mdx\dist\gatsby-node.js:130:65
TypeError: Cannot read properties of undefined (reading 'setParserPlugins')
plugin-options.js:70 enhanceMdxOptions
[kavach-docs]/[smooth-doc]/[gatsby-plugin-mdx]/dist/plugin-options.js:70:33
gatsby-node.js:130 Object.preprocessSource
[kavach-docs]/[smooth-doc]/[gatsby-plugin-mdx]/dist/gatsby-node.js:130:65
api-runner-node.js:485 runAPI
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:485:22
api-runner-node.js:636 Promise.catch.decorateEvent.pluginName
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:636:13
debuggability.js:384 Promise._execute
[kavach-docs]/[bluebird]/js/release/debuggability.js:384:9
promise.js:518 Promise._resolveFromExecutor
[kavach-docs]/[bluebird]/js/release/promise.js:518:18
promise.js:103 new Promise
[kavach-docs]/[bluebird]/js/release/promise.js:103:10
api-runner-node.js:634
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:634:16
util.js:16 tryCatcher
[kavach-docs]/[bluebird]/js/release/util.js:16:23
reduce.js:166 Object.gotValue
[kavach-docs]/[bluebird]/js/release/reduce.js:166:18
reduce.js:155 Object.gotAccum
[kavach-docs]/[bluebird]/js/release/reduce.js:155:25
util.js:16 Object.tryCatcher
[kavach-docs]/[bluebird]/js/release/util.js:16:23
promise.js:547 Promise._settlePromiseFromHandler
[kavach-docs]/[bluebird]/js/release/promise.js:547:31
promise.js:604 Promise._settlePromise
[kavach-docs]/[bluebird]/js/release/promise.js:604:18
promise.js:641 Promise._settlePromiseCtx
[kavach-docs]/[bluebird]/js/release/promise.js:641:10
async.js:97 _drainQueueStep
[kavach-docs]/[bluebird]/js/release/async.js:97:12
ERROR #11321 PLUGIN
"gatsby-plugin-mdx" threw an error while running the preprocessSource lifecycle:
Cannot read properties of undefined (reading 'setParserPlugins')
128 | }
129 |
130 | const mdxOptions = await (0, _pluginOptions.enhanceMdxOptions)(pluginOptions, {
| ^
131 | getNode,
132 | getNodesByType,
133 | pathPrefix,
File: node_modules\smooth-doc\node_modules\gatsby-plugin-mdx\dist\gatsby-node.js:130:65
TypeError: Cannot read properties of undefined (reading 'setParserPlugins')
plugin-options.js:70 enhanceMdxOptions
[kavach-docs]/[smooth-doc]/[gatsby-plugin-mdx]/dist/plugin-options.js:70:33
gatsby-node.js:130 Object.preprocessSource
[kavach-docs]/[smooth-doc]/[gatsby-plugin-mdx]/dist/gatsby-node.js:130:65
api-runner-node.js:485 runAPI
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:485:22
api-runner-node.js:636 Promise.catch.decorateEvent.pluginName
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:636:13
debuggability.js:384 Promise._execute
[kavach-docs]/[bluebird]/js/release/debuggability.js:384:9
promise.js:518 Promise._resolveFromExecutor
[kavach-docs]/[bluebird]/js/release/promise.js:518:18
promise.js:103 new Promise
[kavach-docs]/[bluebird]/js/release/promise.js:103:10
api-runner-node.js:634
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:634:16
util.js:16 tryCatcher
[kavach-docs]/[bluebird]/js/release/util.js:16:23
reduce.js:166 Object.gotValue
[kavach-docs]/[bluebird]/js/release/reduce.js:166:18
reduce.js:155 Object.gotAccum
[kavach-docs]/[bluebird]/js/release/reduce.js:155:25
util.js:16 Object.tryCatcher
[kavach-docs]/[bluebird]/js/release/util.js:16:23
promise.js:547 Promise._settlePromiseFromHandler
[kavach-docs]/[bluebird]/js/release/promise.js:547:31
promise.js:604 Promise._settlePromise
[kavach-docs]/[bluebird]/js/release/promise.js:604:18
promise.js:641 Promise._settlePromiseCtx
[kavach-docs]/[bluebird]/js/release/promise.js:641:10
async.js:97 _drainQueueStep
[kavach-docs]/[bluebird]/js/release/async.js:97:12
ERROR #11321 PLUGIN
"gatsby-plugin-mdx" threw an error while running the preprocessSource lifecycle:
Cannot read properties of undefined (reading 'setParserPlugins')
128 | }
129 |
130 | const mdxOptions = await (0, _pluginOptions.enhanceMdxOptions)(pluginOptions, {
| ^
131 | getNode,
132 | getNodesByType,
133 | pathPrefix,
File: node_modules\smooth-doc\node_modules\gatsby-plugin-mdx\dist\gatsby-node.js:130:65
TypeError: Cannot read properties of undefined (reading 'setParserPlugins')
plugin-options.js:70 enhanceMdxOptions
[kavach-docs]/[smooth-doc]/[gatsby-plugin-mdx]/dist/plugin-options.js:70:33
gatsby-node.js:130 Object.preprocessSource
[kavach-docs]/[smooth-doc]/[gatsby-plugin-mdx]/dist/gatsby-node.js:130:65
api-runner-node.js:485 runAPI
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:485:22
api-runner-node.js:636 Promise.catch.decorateEvent.pluginName
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:636:13
debuggability.js:384 Promise._execute
[kavach-docs]/[bluebird]/js/release/debuggability.js:384:9
promise.js:518 Promise._resolveFromExecutor
[kavach-docs]/[bluebird]/js/release/promise.js:518:18
promise.js:103 new Promise
[kavach-docs]/[bluebird]/js/release/promise.js:103:10
api-runner-node.js:634
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:634:16
util.js:16 tryCatcher
[kavach-docs]/[bluebird]/js/release/util.js:16:23
reduce.js:166 Object.gotValue
[kavach-docs]/[bluebird]/js/release/reduce.js:166:18
reduce.js:155 Object.gotAccum
[kavach-docs]/[bluebird]/js/release/reduce.js:155:25
util.js:16 Object.tryCatcher
[kavach-docs]/[bluebird]/js/release/util.js:16:23
promise.js:547 Promise._settlePromiseFromHandler
[kavach-docs]/[bluebird]/js/release/promise.js:547:31
promise.js:604 Promise._settlePromise
[kavach-docs]/[bluebird]/js/release/promise.js:604:18
promise.js:641 Promise._settlePromiseCtx
[kavach-docs]/[bluebird]/js/release/promise.js:641:10
async.js:97 _drainQueueStep
[kavach-docs]/[bluebird]/js/release/async.js:97:12
ERROR #11321 PLUGIN
"gatsby-plugin-mdx" threw an error while running the preprocessSource lifecycle:
Cannot read properties of undefined (reading 'setParserPlugins')
128 | }
129 |
130 | const mdxOptions = await (0, _pluginOptions.enhanceMdxOptions)(pluginOptions, {
| ^
131 | getNode,
132 | getNodesByType,
133 | pathPrefix,
File: node_modules\smooth-doc\node_modules\gatsby-plugin-mdx\dist\gatsby-node.js:130:65
TypeError: Cannot read properties of undefined (reading 'setParserPlugins')
plugin-options.js:70 enhanceMdxOptions
[kavach-docs]/[smooth-doc]/[gatsby-plugin-mdx]/dist/plugin-options.js:70:33
gatsby-node.js:130 Object.preprocessSource
[kavach-docs]/[smooth-doc]/[gatsby-plugin-mdx]/dist/gatsby-node.js:130:65
api-runner-node.js:485 runAPI
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:485:22
api-runner-node.js:636 Promise.catch.decorateEvent.pluginName
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:636:13
debuggability.js:384 Promise._execute
[kavach-docs]/[bluebird]/js/release/debuggability.js:384:9
promise.js:518 Promise._resolveFromExecutor
[kavach-docs]/[bluebird]/js/release/promise.js:518:18
promise.js:103 new Promise
[kavach-docs]/[bluebird]/js/release/promise.js:103:10
api-runner-node.js:634
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:634:16
util.js:16 tryCatcher
[kavach-docs]/[bluebird]/js/release/util.js:16:23
reduce.js:166 Object.gotValue
[kavach-docs]/[bluebird]/js/release/reduce.js:166:18
reduce.js:155 Object.gotAccum
[kavach-docs]/[bluebird]/js/release/reduce.js:155:25
util.js:16 Object.tryCatcher
[kavach-docs]/[bluebird]/js/release/util.js:16:23
promise.js:547 Promise._settlePromiseFromHandler
[kavach-docs]/[bluebird]/js/release/promise.js:547:31
promise.js:604 Promise._settlePromise
[kavach-docs]/[bluebird]/js/release/promise.js:604:18
promise.js:641 Promise._settlePromiseCtx
[kavach-docs]/[bluebird]/js/release/promise.js:641:10
async.js:97 _drainQueueStep
[kavach-docs]/[bluebird]/js/release/async.js:97:12
ERROR #11321 PLUGIN
"gatsby-plugin-mdx" threw an error while running the preprocessSource lifecycle:
Cannot read properties of undefined (reading 'setParserPlugins')
128 | }
129 |
130 | const mdxOptions = await (0, _pluginOptions.enhanceMdxOptions)(pluginOptions, {
| ^
131 | getNode,
132 | getNodesByType,
133 | pathPrefix,
File: node_modules\smooth-doc\node_modules\gatsby-plugin-mdx\dist\gatsby-node.js:130:65
TypeError: Cannot read properties of undefined (reading 'setParserPlugins')
plugin-options.js:70 enhanceMdxOptions
[kavach-docs]/[smooth-doc]/[gatsby-plugin-mdx]/dist/plugin-options.js:70:33
gatsby-node.js:130 Object.preprocessSource
[kavach-docs]/[smooth-doc]/[gatsby-plugin-mdx]/dist/gatsby-node.js:130:65
api-runner-node.js:485 runAPI
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:485:22
api-runner-node.js:636 Promise.catch.decorateEvent.pluginName
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:636:13
debuggability.js:384 Promise._execute
[kavach-docs]/[bluebird]/js/release/debuggability.js:384:9
promise.js:518 Promise._resolveFromExecutor
[kavach-docs]/[bluebird]/js/release/promise.js:518:18
promise.js:103 new Promise
[kavach-docs]/[bluebird]/js/release/promise.js:103:10
api-runner-node.js:634
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:634:16
util.js:16 tryCatcher
[kavach-docs]/[bluebird]/js/release/util.js:16:23
reduce.js:166 Object.gotValue
[kavach-docs]/[bluebird]/js/release/reduce.js:166:18
reduce.js:155 Object.gotAccum
[kavach-docs]/[bluebird]/js/release/reduce.js:155:25
util.js:16 Object.tryCatcher
[kavach-docs]/[bluebird]/js/release/util.js:16:23
promise.js:547 Promise._settlePromiseFromHandler
[kavach-docs]/[bluebird]/js/release/promise.js:547:31
promise.js:604 Promise._settlePromise
[kavach-docs]/[bluebird]/js/release/promise.js:604:18
promise.js:641 Promise._settlePromiseCtx
[kavach-docs]/[bluebird]/js/release/promise.js:641:10
async.js:97 _drainQueueStep
[kavach-docs]/[bluebird]/js/release/async.js:97:12
ERROR #85901 GRAPHQL
There was an error in your GraphQL query:
Field "fields" is not defined by type MdxFilterInput.
File: node_modules\smooth-doc\src\components\SideNav.js:9:22
GraphQLError: Field "fields" is not defined by type MdxFilterInput.
query-compiler.js:212 extractOperations
[kavach-docs]/[gatsby]/src/query/query-compiler.js:212:20
query-compiler.js:171 processQueries
[kavach-docs]/[gatsby]/src/query/query-compiler.js:171:45
query-compiler.js:82 compile
[kavach-docs]/[gatsby]/src/query/query-compiler.js:82:19
task_queues:95 processTicksAndRejections
node:internal/process/task_queues:95:5
query-watcher.ts:220 updateStateAndRunQueries
[kavach-docs]/[gatsby]/src/query/query-watcher.ts:220:40
extract-queries.ts:18 extractQueries
[kavach-docs]/[gatsby]/src/services/extract-queries.ts:18:3
ERROR #85923 GRAPHQL
There was an error in your GraphQL query:
Cannot query field "fields" on type "Mdx".
If you don't expect "fields" to exist on the type "Mdx" it is most likely a typo.
However, if you expect "fields" to exist there are a couple of solutions to common problems:
It is recommended to explicitly type your GraphQL schema if you want to use optional fields. This way you don't have to add the mentioned "dummy content".
Visit our docs to learn how you can define the schema for "Mdx":
https://www.gatsbyjs.org/docs/schema-customization/#creating-type-definitions
File: node_modules\smooth-doc\src\templates\page.js:6:7
ERROR #85923 GRAPHQL
There was an error in your GraphQL query:
Cannot query field "fields" on type "Mdx".
If you don't expect "fields" to exist on the type "Mdx" it is most likely a typo.
However, if you expect "fields" to exist there are a couple of solutions to common problems:
It is recommended to explicitly type your GraphQL schema if you want to use optional fields. This way you don't have to add the mentioned "dummy content".
Visit our docs to learn how you can define the schema for "Mdx":
https://www.gatsbyjs.org/docs/schema-customization/#creating-type-definitions
File: node_modules\smooth-doc\src\templates\doc.js:6:7
failed extract queries from components - 0.956s
success write out requires - 0.018s
success run static queries - 0.075s - 5/5 66.55/s
success run page queries - 0.035s - 1/1 28.47/s
ERROR #11321 PLUGIN
"gatsby-plugin-mdx" threw an error while running the onCreateWebpackConfig lifecycle:
Cannot read properties of undefined (reading 'setParserPlugins')
40 | }, pluginOptions) => {
41 | const options = (0, _pluginOptions.defaultOptions)(pluginOptions);
42 | const mdxOptions = await (0, _pluginOptions.enhanceMdxOptions)(pluginOptions, {
| ^
43 | getNode,
44 | getNodesByType,
45 | pathPrefix,
File: node_modules\smooth-doc\node_modules\gatsby-plugin-mdx\dist\gatsby-node.js:42:65
TypeError: Cannot read properties of undefined (reading 'setParserPlugins')
plugin-options.js:70 enhanceMdxOptions
[kavach-docs]/[smooth-doc]/[gatsby-plugin-mdx]/dist/plugin-options.js:70:33
gatsby-node.js:42 Object.onCreateWebpackConfig
[kavach-docs]/[smooth-doc]/[gatsby-plugin-mdx]/dist/gatsby-node.js:42:65
api-runner-node.js:485 runAPI
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:485:22
api-runner-node.js:636 Promise.catch.decorateEvent.pluginName
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:636:13
debuggability.js:384 Promise._execute
[kavach-docs]/[bluebird]/js/release/debuggability.js:384:9
promise.js:518 Promise._resolveFromExecutor
[kavach-docs]/[bluebird]/js/release/promise.js:518:18
promise.js:103 new Promise
[kavach-docs]/[bluebird]/js/release/promise.js:103:10
api-runner-node.js:634
[kavach-docs]/[gatsby]/src/utils/api-runner-node.js:634:16
util.js:16 tryCatcher
[kavach-docs]/[bluebird]/js/release/util.js:16:23
reduce.js:166 Object.gotValue
[kavach-docs]/[bluebird]/js/release/reduce.js:166:18
reduce.js:155 Object.gotAccum
[kavach-docs]/[bluebird]/js/release/reduce.js:155:25
util.js:16 Object.tryCatcher
[kavach-docs]/[bluebird]/js/release/util.js:16:23
promise.js:547 Promise._settlePromiseFromHandler
[kavach-docs]/[bluebird]/js/release/promise.js:547:31
promise.js:604 Promise._settlePromise
[kavach-docs]/[bluebird]/js/release/promise.js:604:18
promise.js:649 Promise._settlePromise0
[kavach-docs]/[bluebird]/js/release/promise.js:649:10
promise.js:729 Promise._settlePromises
[kavach-docs]/[bluebird]/js/release/promise.js:729:18
warn isModuleDeclaration
has been deprecated, please migrate to isImportOrExportDeclaration
at isModuleDeclaration (C:\Users\salve\OneDrive\Desktop\Kavach
Documentation\kavach-docs\node_modules@babel\types\lib\validators\generated\index.js:3940:35)
at PluginPass.Program (C:\Users\salve\OneDrive\Desktop\Kavach Documentation\kavach-docs\node_modules\babel-plugin-lodash\lib\index.js:102:44)
ERROR
error:0308010C:digital envelope routines::unsupported
Error: error:0308010C:digital envelope routines::unsupported
hash:71 new Hash
node:internal/crypto/hash:71:19
node:crypto:133 Object.createHash
node:crypto:133:10
createHash.js:135 module.exports
[kavach-docs]/[webpack]/lib/util/createHash.js:135:53
NormalModule.js:417 NormalModule._initBuildHash
[kavach-docs]/[webpack]/lib/NormalModule.js:417:16
NormalModule.js:471 handleParseError
[kavach-docs]/[webpack]/lib/NormalModule.js:471:10
NormalModule.js:503
[kavach-docs]/[webpack]/lib/NormalModule.js:503:5
NormalModule.js:358
[kavach-docs]/[webpack]/lib/NormalModule.js:358:12
LoaderRunner.js:373
[kavach-docs]/[loader-runner]/lib/LoaderRunner.js:373:3
LoaderRunner.js:214 iterateNormalLoaders
[kavach-docs]/[loader-runner]/lib/LoaderRunner.js:214:10
LoaderRunner.js:221 iterateNormalLoaders
[kavach-docs]/[loader-runner]/lib/LoaderRunner.js:221:10
LoaderRunner.js:236
[kavach-docs]/[loader-runner]/lib/LoaderRunner.js:236:3
LoaderRunner.js:111 context.callback
[kavach-docs]/[loader-runner]/lib/LoaderRunner.js:111:13
index.js:44
[kavach-docs]/[babel-loader]/lib/index.js:44:71
#I am getting this error
--legacy-peer-deps and --force
The default 404 makes the build fail. Any starter with smooth-doc will show this.
The reason is that <Link/>
is used without being imported: https://github.com/gregberge/smooth-doc/blob/master/smooth-doc/pages/404.mdx#L27
Please can you make a release build for the latest fix with the default branch.
I found that when we click on the right-side topic and it scrolls the page to that topic but the topic heading goes behind the header ... how can I fix this? I want that scroll should stop 1rem below the top while scrolling to that particular topic
Error when building blank smooth-doc project
failed Building static HTML for pages - 6.550s
ERROR #95313
Building static HTML failed for path "/404/"
See our docs page for more info on this error: https://gatsby.dev/debug-html
17 | }
18 |
> 19 | return _construct.apply(null, arguments);
| ^
20 | }
21 |
22 | module.exports = _construct;
WebpackError: ReferenceError: Link is not defined
- construct.js:19
node_modules/@babel/runtime/helpers/construct.js:19:1
npx gatsby-cli new website https://github.com/gregberge/smooth-doc-starter
cd website
yarn build
It to build, but it does not
N/A
Issues without a reproduction link are likely to stall.
npx envinfo --system --binaries --npmPackages smooth-doc,gatsby,react,react-dom --markdown --clipboard
Paste the results here:
*** Clipboard option removed - use clipboardy or clipboard-cli directly ***
## System:
- OS: macOS 10.15.7
- CPU: (8) x64 Intel(R) Core(TM) i7-7700HQ CPU @ 2.80GHz
- Memory: 715.03 MB / 16.00 GB
- Shell: 5.7.1 - /bin/zsh
## Binaries:
- Node: 12.9.1 - /usr/local/bin/node
- Yarn: 1.22.0 - ~/.yarn/bin/yarn
- npm: 6.13.4 - /usr/local/bin/npm
## npmPackages:
- gatsby: ^2.15.18 => 2.24.80
- react: ^16.10.1 => 16.14.0
- react-dom: ^16.10.1 => 16.14.0
- smooth-doc: ^5.0.4 => 5.1.1
Add four more pages using the same layout, each with separate sideNav. Users should be able to access the respective docs from the topNav (preferably a dropdown)
Docs
Product 1
Product 2
Search integration: elasticlunr/ lunr
(See menu items (Products/ Dev docs from the top nav. Screenshot attached)
Hi! First, thanks for the awesome plugin, it's certainly what I was looking for.
I have a question: is the entry point pages/index.mdx
or does it allow regular pages/index.tsx
?
Right now I have a small website with a few non-doc pages and a doc-specific area (this is where I intend to use Smooth Doc). I'd like to know if it's possible to have the regular entry point/website with *.tsx and the docs with the *.mdx extension, or must I convert my *.tsx to *.mdx?
Thank you!
info Creating new site from git:
https://github.com/gregberge/smooth-doc-starter.git
Cloning into 'website'...
remote: Enumerating objects: 16, done.
remote: Counting objects: 100% (16/16), done.
remote: Compressing objects: 100% (13/13), done.
remote: Total 16 (delta 1), reused 13 (delta 1), pack-reused 0
Receiving objects: 100% (16/16), 366.55 KiB | 1.49 MiB/s, done.
success Created starter directory layout
info Installing packages...
npm ERR! code ERESOLVE
npm ERR! ERESOLVE unable to resolve dependency tree
npm ERR!
npm ERR! While resolving: [email protected]
npm ERR! Found: [email protected]
npm ERR! node_modules/react
npm ERR! react@"^16.10.1" from the root project
npm ERR! peer react@"^16.4.2 || ^17.0.0" from [email protected]
npm ERR! node_modules/gatsby
npm ERR! gatsby@"^2.15.18" from the root project
npm ERR! peer gatsby@"^2.15.0" from [email protected]
npm ERR! node_modules/smooth-doc
npm ERR! smooth-doc@"^5.0.4" from the root project
npm ERR! 1 more (react-dom)
npm ERR!
npm ERR! Could not resolve dependency:
npm ERR! peer react@"^16.9.0 | ^17.0.0" from [email protected]
npm ERR! node_modules/smooth-doc
npm ERR! smooth-doc@"^5.0.4" from the root project
npm ERR!
npm ERR! Fix the upstream dependency conflict, or retry
npm ERR! this command with --force, or --legacy-peer-deps
npm ERR! to accept an incorrect (and potentially broken) dependency resolution.
npm ERR!
npm ERR! See /Users/sunfeipo/.npm/eresolve-report.txt for a full report.
npm ERR! A complete log of this run can be found in:
ERROR
Command failed with exit code 1: npm install
Error: Command failed with exit code 1: npm install
error.js:60 makeError
[21aee85bd6ee71e0]/[execa]/lib/error.js:60:11
index.js:118 handlePromise
[21aee85bd6ee71e0]/[execa]/index.js:118:26
task_queues:96 processTicksAndRejections
node:internal/process/task_queues:96:5
init-starter.js:135 install
[21aee85bd6ee71e0]/[gatsby-cli]/lib/init-starter.js:135:7
init-starter.js:202 clone
[21aee85bd6ee71e0]/[gatsby-cli]/lib/init-starter.js:202:3
init-starter.js:343 initStarter
[21aee85bd6ee71e0]/[gatsby-cli]/lib/init-starter.js:343:5
create-cli.js:489
[21aee85bd6ee71e0]/[gatsby-cli]/lib/create-cli.js:489:9
I used the following commands in two places to install and test. One is a macbook and the other is aws, both of which have errors. How to do it?
npx gatsby-cli new website https://github.com/gregberge/smooth-doc-starter
Clicking on right sidebar anchor links don't scroll the page. This seems to be linked to this issue: gatsbyjs/gatsby#27431
https://smooth-doc.com/docs/getting-started/
While waiting this is resolved on Gatbsy's side, I would suggest using the <a />
tag instead of Gatsby <Link />
component here:
Let me know what you think I can make a PR if you'd like.
First off, thanks for releasing this project, it looks really promising! I plan to try publishing an interactive e-book with it :)
I noticed that the getting started docs assume that you want to create a new Gatsby project based on the provided template.
This probably makes sense for a lot of people, but it might be helpful to also explain how to integrate it into an existing Gatsby project?
In my case, I ended up creating a separate Gatsby project, running gatsby build --prefix-paths
and moving its generated public/
directory inside another, top-level Gatsby project. It feels a little hacky, but it works :)
A declarative, efficient, and flexible JavaScript library for building user interfaces.
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. πππ
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google β€οΈ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.