Giter VIP home page Giter VIP logo

cwdocs's Introduction

Installation

###Prerequisites:

CWDocs is using MkDocs, static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

In order to use and build the docs page you'll need Python 2.7, Python Package Indexer

Run these commands to check if you have these installed:

$ python --version
Python 2.7.2
$ pip --version
pip 8.1.0

Install the MkDocs package using pip and Material Design theme for MkDocs:

$ pip install mkdocs
$ pip install mkdocs-material
$ mkdocs --version
mkdocs, version 0.15.3

Go to your local directory, for example c:\docs\ and clone this git repository

$ git clone https://github.com/gufu/cwdocs.git

Usage

In your root docs folder run $ mkdocs serve command to start your local preview of CWDocs page.

$ mkdocs serve
Running at: http://127.0.0.1:8000/

To build CWDocs for production usage, run:

$ mkdocs build --clean

As a result, site folder will be created with static production version of CWDocs.

cwdocs's People

Contributors

wheresmyskin avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.