About Spot the Docs

Spot the Docs is a lightweight Laravel/Heroku web app that finds open-source projects with documentation issues using GitHub's API.

• GitHub
• Heroku

Commands

Using MKDocs

• mkdocs new [dir-name] - Create a new project.
• mkdocs serve - Start the live-reloading docs server.
• mkdocs build - Build the documentation site.
• mkdocs help - Print this help message.

Project Layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    about.md  # The about page.