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

spacebook as just a docs generation tool #18

Closed
rambabusaravanan opened this issue Dec 28, 2020 · 4 comments
Closed

spacebook as just a docs generation tool #18

rambabusaravanan opened this issue Dec 28, 2020 · 4 comments

Comments

@rambabusaravanan
Copy link

Is your feature request related to a problem? Please describe.
Just a feature, not a problem.

Describe the solution you'd like
I am looking for a docs generation tool (a minimal version of yours) without any cms integration

Describe alternatives you've considered
gitbook-cli, docusarus are the options I tried for converting md into docs site.

Additional context
I just want to use eleventy to make it as simple as possible, but instead of writing css and layout for sidebar, thought of using a template. Would be good if you publish a minimal variant just for docs generation

@broeker
Copy link
Owner

broeker commented Dec 29, 2020

Hi @rambabusaravanan thanks for the feedback.

What you describe above is basically my goal. The CMS integration (along with search, dark mode, etc.) are all completely optional. The Netlify CMS in particular is disabled by default, and none of the Netlify scripts are loaded unless you enable that option. My goal is to keep this as minimal as possible but also provide some options for people not technical or who would otherwise prefer a CMS.

Is there some reason that including the option is a problem for your goals?

@rambabusaravanan
Copy link
Author

I like your approach and maybe using it in my next project where I expect the need for cms.

In the current case, I am using and deleting unwanted files and folders. For people looking like me, may fell in love if you have a another variant like 'spacebook-slim' or at least a cli like jhipster that generates the folder based on the needs.

This is just a feature request, feel free to close it

@broeker
Copy link
Owner

broeker commented Dec 29, 2020

Yeah, I don't like that the default currently includes all of the files. I love the idea of cli or at least just loading with a minimal amount of sample files. Thanks again for the feedback.

@broeker broeker closed this as completed Dec 29, 2020
@broeker
Copy link
Owner

broeker commented Jan 2, 2021

@rambabusaravanan just FYI this doesn't completely fulfill your request, but I've removed all of the docs/demo content from the main branch. Now when you install, you will get a single "hello world" page instead of all the docs. The CMS is disabled by default and you can simply ignore it, but it remains as an option.

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

No branches or pull requests

2 participants