Welcome to PythonKSS’s documentation!

This is a library for parsing the KSS format (with some extra formatting sugar).

If you are looking for a way to render the styleguide, write your own using https://github.com/appressoas/pythonkss/blob/master/examples/startingpoint.py as a starting point.

Install

pip install pythonkss

Getting started

Take a look at https://github.com/appressoas/pythonkss/blob/master/examples/startingpoint.py, or read the PythonKSS API.

Contents:

• Style documenation syntax
  • Documentation format
    • Format overview
    • Title
    • Description
    • Reference
    • Example
  • Markdown format
    • Paragraphs
    • Headings
    • Text styles
    • Links
    • Lists
    • Blockquotes
    • HTML mixed with the Markdown
    • Escape Markdown characters
    • Code blocks
  • Markdown format details
  • Extending styleguide sections
    • StyleguideExtendBefore and StyleguideExtendAfter
    • StyleguideReplace
    • Parse order for extending styleguide sections
• PythonKSS API
  • The core API
  • Utilities used by the core API
• Develop PythonKSS
  • Setup
  • Run tests
  • Run the example

Indices and tables

• Index
• Module Index
• Search Page