Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
fwouts opened this issue Jan 30, 2021 · 3 comments
Open

Comments

@fwouts
Copy link
Contributor

fwouts commented Jan 30, 2021

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

@kbariotis
Copy link

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.

@gregberge
Copy link
Owner

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.

@fwouts
Copy link
Contributor Author

fwouts commented Feb 1, 2021

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants