smooth-doc icon indicating copy to clipboard operation
smooth-doc copied to clipboard

Suggestion: Documentation to add smooth-doc to an existing Gatsby project

Open fwouts opened this issue 4 years ago • 3 comments

💬 Questions and Help

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 :)

fwouts avatar Jan 30 '21 07:01 fwouts

I came here to write exactly that.

As @fwouts mentioned, this is an amazing project and thank you for your work.

My suggestion would be to be able to plug in smooth-doc in an existing project. So, assuming that I already have a src/pages folder with an existing index page, I would like smooth-doc to take effect in all pages under /docs and let me write other pages with my existing theme.

Thank you, let us know what are your thoughts @gregberge, I would love to contribute to this project.

kbariotis avatar Jan 31 '21 14:01 kbariotis

Hello @fwouts, @kbariotis I think it is a good addition! Feel free to contribute, maybe an option could permit to change the directory if necessary. It is mostly documentation here.

gregberge avatar Jan 31 '21 19:01 gregberge

I'd love to help but I'm a bit too unfamiliar with Gatsby at this stage. @kbariotis go for it! Happy to provide feedback on drafts though.

fwouts avatar Feb 01 '21 07:02 fwouts