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

Renaming the website folder #1082

Closed
1 task done
noraj opened this issue Nov 1, 2018 · 7 comments
Closed
1 task done

Renaming the website folder #1082

noraj opened this issue Nov 1, 2018 · 7 comments
Labels
difficulty: starter Issues that are starter difficulty level, e.g. minimal tweaking with a clear test plan. documentation The issue is related to the documentation of Docusaurus help wanted Asking for outside help and/or contributions to this particular issue or PR.

Comments

@noraj
Copy link
Contributor

noraj commented Nov 1, 2018

📚 Documentation

In the config file there is an optional customDocsPath to allow costuming of the doc folder name.
As the website/ directory is the base directory, it can be renamed as we want, for example if conflicting with another folder because you put the docusaurus project inside your real software project.

So the documentation should say that we can rename it.

@endiliey endiliey added help wanted Asking for outside help and/or contributions to this particular issue or PR. documentation The issue is related to the documentation of Docusaurus difficulty: starter Issues that are starter difficulty level, e.g. minimal tweaking with a clear test plan. labels Nov 7, 2018
@andrewShillito
Copy link
Contributor

@noraj I was thinking that the pictured section (under bullet 2) at docusaurus installation page would be a good place to add a note that the website folder name can be changed in the config file. Does that sound like what you are looking for?
img

@noraj
Copy link
Contributor Author

noraj commented Nov 7, 2018

@andrewShillito I think it will be better fitted in getting-started-preparation.md than in getting-started-installation.md. Maybe in the section Preparation Notes.

@yangshun
Copy link
Contributor

PRs are welcome for this 😄

@noraj
Copy link
Contributor Author

noraj commented Nov 11, 2018

@andrewShillito Thanks for you PR but you added information about customDocsPath (that's not a bad thing) that allows to modify the name of the folder named docs by default (that is documented here https://docusaurus.io/docs/en/site-config#customdocspath-string).
But my issue was talking about the ability to rename the website folder that is undocumented right now. I'll make a PR when I will have time.

noraj added a commit to noraj/Docusaurus that referenced this issue Nov 11, 2018
@yangshun
Copy link
Contributor

Thanks for fixing this @noraj !

@andrewShillito
Copy link
Contributor

@noraj Sorry I misunderstood that! I will make sure to double check I'm not misunderstanding the issue before contributing next time. Thanks.

@noraj
Copy link
Contributor Author

noraj commented Nov 12, 2018

@andrewShillito Actually not a problem because your contribution is good too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: starter Issues that are starter difficulty level, e.g. minimal tweaking with a clear test plan. documentation The issue is related to the documentation of Docusaurus help wanted Asking for outside help and/or contributions to this particular issue or PR.
Projects
None yet
Development

No branches or pull requests

4 participants