Skip to content

User Guide

User Guide⚓︎

Building Documentation with ProperDocs⚓︎

ProperDocs User Guide

The ProperDocs User Guide provides documentation for users of ProperDocs. See Getting Started for an introductory tutorial. You can jump directly to a page listed below, or use the next and previous buttons in the navigation bar at the top of the page to move through the documentation in order.

  • Installation
    View Guide

    Step-by-step instructions to get ProperDocs up and running.

  • Writing Your Docs
    View Guide

    How to layout and write your Markdown source files.

  • Choosing Your Theme
    View Guide

    Selecting and configuring a theme.

  • Customizing Your Theme
    View Layout

    Altering a theme to suit your needs.

  • Localizing Your Theme
    Preferred Language

    Display your theme in your preferred language.

  • Configuration
    View Guide

    Guide to all available configuration settings.

  • Cmd Line Interface
    View Settings

    ProperDocs - Project documentation with Markdown.

  • Deploying Docs
    Deploying

    Basic guide to deploying docs to various hosting providers

  • Getting Started
    Intro. Tutorial

    Install ProperDocs and a basic theme.