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

feature request: local project files in siteConfig.scripts & siteConfig.stylesheets #534

Closed
zenflow opened this issue Apr 8, 2018 · 5 comments
Labels
feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future.

Comments

@zenflow
Copy link
Contributor

zenflow commented Apr 8, 2018

We want to include our library distributable in the pages of our documentation site to demonstrate it. There's also a 3rd-party (vendor) script in the node_modules dir that we need to include (to make the indicated code blocks "executable").

Is there a nice way to include local project files in siteConfig.scripts that are outside the ./website/static/ dir?

Right now I'm copying the needed files into ./website/static/vendor at the beginning of every script (start, build, publish), and adding that dir to .gitignore, but it feels hacky.

I propose we treat relative paths in siteConfig.scripts & siteConfig.stylesheets as relative to the location of siteConfig.js and copy those files into the build.

Would the maintainers welcome a PR to add this?

@yangshun
Copy link
Contributor

yangshun commented May 4, 2018

I think this is a reasonable suggestion. PR welcome!

In future we might want to move to a bundler like webpack, rollup or parcel though.

@Airse
Copy link
Contributor

Airse commented May 6, 2018

@yangshun I wouldn't mind working on this!

@yangshun
Copy link
Contributor

yangshun commented May 6, 2018

@Airse Awesome, it's yours!

@yangshun yangshun added feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. status: claimed Issue has been claimed by a contributor who plans to work on it. labels May 6, 2018
@yangshun yangshun mentioned this issue Jun 20, 2018
@endiliey endiliey added v2-mvp and removed v2-mvp labels Aug 28, 2018
@yangshun yangshun removed the status: claimed Issue has been claimed by a contributor who plans to work on it. label Oct 14, 2018
@nebrelbug
Copy link
Contributor

Has there been any progress on this?

@endiliey
Copy link
Contributor

Wontfix in v1 with v2 coming up

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future.
Projects
None yet
Development

No branches or pull requests

5 participants