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: init command #872

Open
kMutagene opened this issue Nov 17, 2023 · 0 comments
Open

Suggestion: init command #872

kMutagene opened this issue Nov 17, 2023 · 0 comments

Comments

@kMutagene
Copy link
Contributor

kMutagene commented Nov 17, 2023

I have grown the habit of copy-pasting and adjusting my go-to folder structure and _template.html file whenever i create docs for a new project.

However, i can understand new users being confused by the actual setup process, as you have to create a folder structure with multiple files by hand. I think it is reasonable for a tool such as fsdocs to provide a single command that initializes the necessary folder structure for the documentation folder.

For this, i suggest the addition of a fsdocs init command, which could have flags for also adding other templates, e.g., _template.ipynb, as well as svg files for download notebook or download script links (see for example here on the top of the page)

This could also be used for some automated SEO tags, see #869 (there is a default template, which should be adjusted and created by this init command)

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

1 participant