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

Broken Documentation #46

Open
SameerSawla opened this issue Mar 31, 2020 · 3 comments
Open

Broken Documentation #46

SameerSawla opened this issue Mar 31, 2020 · 3 comments

Comments

@SameerSawla
Copy link

Javascript usage documentation seems to be broken. I am not able to move forward with the sample example added to the respective ReadMe.md

It starts with

require(...).load is not a function. 
@nknapp
Copy link
Member

nknapp commented Apr 1, 2020

Please look at the repository "bootprint-monorepo". It conatins the current version

@sudeshbanskota
Copy link

Hi documentation is broken in your booprint-monorepo as well. https://github.com/bootprint/bootprint-monorepo/blob/master/packages/bootprint/doc/js.md shows the wrong JS usage.

@nknapp
Copy link
Member

nknapp commented Apr 11, 2020

Oh, yes. I have fixed the documentation now at this point. Thank you.

If you'd rather use bootprint like it was used before, you can also use customize directly.
Similar to this:

const write = require('customize-write-files')

return customize()
    .registerEngine('handlebars', require('customize-engine-handlebars'))
    .registerEngine('less', require('customize-engine-less'))
    .load(...)
    .merge(...')
    .run()
    .then(write(targetDir), console.error);

This should be documented, but it isn't yet.

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

3 participants