https://github.com/idank/showthedocs

https://github.com/idank/showthedocs

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/idank/showthedocs
• Owner: idank
• Created: 2016-05-31T23:13:30.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-06-17T21:19:48.000Z (over 8 years ago)
• Last Synced: 2024-08-01T12:33:41.176Z (3 months ago)
• Language: JavaScript
• Homepage: http://showthedocs.com
• Size: 315 KB
• Stars: 248
• Watchers: 6
• Forks: 23
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: contributing.md

Awesome Lists containing this project

• awesome-starred - idank/showthedocs - (others)

README

        
showthedocs annotates code to show you the relevant pieces of its

documentation, read more [here](http://showthedocs.com/about).

# Running locally

    git clone https://github.com/idank/showthedocs.git

    cd showthedocs

    pip install -r requirements.txt

    ./getdocs clone

    python runserver.py

These commands will clone this repo, install the dependencies, download the

processed docs and run a local server.