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

fix: remove clean documentation theme #337

Closed
wants to merge 2 commits into from

Conversation

hugomrdias
Copy link
Member

@hugomrdias hugomrdias commented Feb 25, 2019

clean-documentation-theme depends on highlight.js which is breaking all npm i run this PR removes clean-documentation-theme

@ghost ghost assigned hugomrdias Feb 25, 2019
@ghost ghost added the status/in-progress In progress label Feb 25, 2019
@@ -69,7 +69,7 @@ function build (ctx) {
if (fmt === 'html') {
return documentation.build(files, getOpts(pkg))
.then((docs) => documentation.formats.html(docs, {
theme: require.resolve('clean-documentation-theme'),
// theme: require.resolve('clean-documentation-theme'),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not just removing it?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@hugomrdias hugomrdias requested a review from vmx February 25, 2019 14:29
Copy link
Member

@vmx vmx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More of a general note for the future: I like if commit messages also mention the why.

@hugomrdias
Copy link
Member Author

the merge will include the why

@alanshaw
Copy link
Member

Temporarily right because the docs command uses it?

@hugomrdias
Copy link
Member Author

We might just use the default one. These docs aren't used much it's mostly readme docs.
What do you think?

@hugomrdias
Copy link
Member Author

i think im gonna cancel this because documentation.js itself depends on highlight.js ...

@jacobheun
Copy link
Contributor

Perhaps it would be good to do a pilot of shrinkwrap for aegir, #330. It would solve this kind of problem, and since it's a dev dependency would be a good project to run a pilot on.

@hugomrdias
Copy link
Member Author

closing this, problem was fixed upstream

@hugomrdias hugomrdias closed this Feb 26, 2019
@ghost ghost removed the status/in-progress In progress label Feb 26, 2019
@hugomrdias hugomrdias deleted the fix/remove-clean-documentation-theme branch February 26, 2019 11:25
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

Successfully merging this pull request may close these issues.

5 participants