crocks icon indicating copy to clipboard operation
crocks copied to clipboard

Update documentation framework with docusaurus

Open davidnussio opened this issue 5 years ago • 9 comments

Update documentation framework #459

  • Migrated old doc to new framework
  • Documentation search with local generated files (no Algolia service)
  • Integrated runnable examples with runkit

How to test:

  • Local develop: yarn start
  • Deploy on crocks.github.io/crocks: GIT_USER=evilsoft USE_SSH=true yarn run deploy
  • Change deploy url and baseUrl: change them in docusaurus.config.js

See PR in action

  • https://davidnussio.github.io/crocks/

davidnussio avatar Feb 24 '21 20:02 davidnussio

Gonna give this a Play tonight! Amazing!

Quick question why were the comments in the code files changed to \** ... *\ from \\?

evilsoft avatar Feb 24 '21 21:02 evilsoft

I checked, there is a commit from master in the pull request (I forked the master to get an updated version of code) Screenshot 2021-02-24 221750

davidnussio avatar Feb 24 '21 21:02 davidnussio

Oh gotcha. Sorry I missed that.

evilsoft avatar Feb 24 '21 21:02 evilsoft

I broke CI but there is a warning message in travis: Please be aware travis-ci.org will be shutting down in several weeks, with all accounts migrating to travis-ci.com. Please stay tuned here for more information. Maybe this work could be moved to GitHub Action?

davidnussio avatar Feb 24 '21 21:02 davidnussio

Not sure how i missed this PR coming in. Can check it out, nice work mate

dalefrancis88 avatar Mar 02 '21 20:03 dalefrancis88

🎉 CI is 🟢 again Lint was failing with JSX components into documentation js files

davidnussio avatar Mar 13 '21 12:03 davidnussio

@evilsoft @dalefrancis88 if the PR will be accepted could I submit crocks.dev to docusaurus showcase?

Immagine 2021-03-16 074500

davidnussio avatar Mar 16 '21 06:03 davidnussio

I'll need to catch up with @evilsoft on this one but this is looking good

dalefrancis88 avatar May 07 '21 05:05 dalefrancis88

Any update on this?

kierans avatar Apr 23 '23 06:04 kierans