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

doc: add next.js to the examples #46

Merged
merged 2 commits into from Dec 31, 2020
Merged

doc: add next.js to the examples #46

merged 2 commits into from Dec 31, 2020

Conversation

bravo-kernel
Copy link
Contributor

No description provided.

@sastan
Copy link
Collaborator

sastan commented Dec 31, 2020

Awesome! Just one thing. Could you please run yarn format to update the TOC. Then this is good to merge.

Thank you so much!

@bravo-kernel
Copy link
Contributor Author

You're welcome. The yarn format is breaking on my (Windows) machine though.

$ yarn format
yarn run v1.22.5
$ doctoc --update-only --notitle --maxlevel 3 docs/*.md
internal/fs/utils.js:307
    throw err;
    ^

Error: ENOENT: no such file or directory, stat 'docs/*.md'
    at Object.statSync (fs.js:1086:3)
    at Object.<anonymous> (D:\VScodeProjects\Javascript\twind\node_modules\doctoc\doctoc.js:113:17)
    at Module._compile (internal/modules/cjs/loader.js:1063:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1092:10)
    at Module.load (internal/modules/cjs/loader.js:928:32)
    at Function.Module._load (internal/modules/cjs/loader.js:769:14)
    at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:72:12)
    at internal/main/run_main_module.js:17:47 {
  errno: -4058,
  syscall: 'stat',
  code: 'ENOENT',
  path: 'docs/*.md'
}
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

@bravo-kernel
Copy link
Contributor Author

I have manually added the TOC, hope that suffices for now.

@sastan
Copy link
Collaborator

sastan commented Dec 31, 2020

You're welcome. The yarn format is breaking on my (Windows) machine though.

$ yarn format
yarn run v1.22.5
$ doctoc --update-only --notitle --maxlevel 3 docs/*.md
internal/fs/utils.js:307
    throw err;
    ^

Error: ENOENT: no such file or directory, stat 'docs/*.md'
    at Object.statSync (fs.js:1086:3)
    at Object.<anonymous> (D:\VScodeProjects\Javascript\twind\node_modules\doctoc\doctoc.js:113:17)
    at Module._compile (internal/modules/cjs/loader.js:1063:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1092:10)
    at Module.load (internal/modules/cjs/loader.js:928:32)
    at Function.Module._load (internal/modules/cjs/loader.js:769:14)
    at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:72:12)
    at internal/main/run_main_module.js:17:47 {
  errno: -4058,
  syscall: 'stat',
  code: 'ENOENT',
  path: 'docs/*.md'
}
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

Thanks for that. I think this works with shell that do expansions docs/*.md => docs/README.md docs/tw.md ...
Did you use the power shell?

Maybe this can be written in a more portable way. I'll look into this.

@sastan sastan merged commit da82c54 into tw-in-js:main Dec 31, 2020
@bravo-kernel
Copy link
Contributor Author

bravo-kernel commented Dec 31, 2020

Thanks. I have tried running this inside both Git Bash and the Windows Terminal. Both with the same error.

Good luck with the UI and happy new year to you 🧨

@bravo-kernel bravo-kernel deleted the next-example branch December 31, 2020 13:41
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.

None yet

2 participants