Skip to content

annalifatou/docs-shuffle

Repository files navigation

Docs shuffle 🛳

Go on a cruise through some documentation with this fancy cmdline utlity.

Screenshot

Docs shuffle

How to setup

  1. Install dependencies (& build .go file)
npm install
  1. Run it
sh docs-shuffler.sh <playlist>

# Run included example (exclude the .csv)
sh docs-shuffler.sh example
  1. Add some playlists. Use a link extractor on the index of the documentation. Copy and paste the links into a csv and save them under the playlists folder.

  2. Update docs-shuffle.sh with your installation path. Note: If you add the path to this script to your $PATH, you can run this shell script from any folder.

About

Get exposure to new concepts and features with a random link generator. Works great for lengthy documentation, such as for Python 3.

Resources

Stars

Watchers

Forks