Name: docs-riff
Owner: Cloud Foundry
Description: null
Created: 2018-05-09 14:42:43.0
Updated: 2018-05-14 19:10:56.0
Pushed: 2018-05-17 13:38:53.0
Homepage: null
Size: 195
Language: HTML
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
Welcome to the Riff documentation!
This repo contains the content for the Riff documentation, which is currently under development at https://docs-riff.cfapps.io.
The Riff documentation is published with MkDocs, using a customized version of the Material theme.
MkDocs is a Python application that generates a static web app from Markdown files. Each topic in the Riff documentation is represented by a Markdown file in the docs
directory.
Please help us improve the accuracy and completeness of the Riff documentation by contributing.
The easiest way to contribute is to file a pull request through GitHub.
To a file a pull request, perform the following steps:
You can also create an issue. Issues are repo-wide, so please indicate which topic or topics you are leaving feedback for.
The Riff documentation is written in Markdown, but it also uses an MkDocs extension called Admonition that enables block-styled side content, such as notes, hints or warnings. See the Admonition documentation for more information about usage.
You can use MkDocs to view a live version of the Riff documentation on your local machine. This can be useful if you are submitting a pull request with substantial changes to the documentation.
Perform the following steps to preview your changes:
Install MkDocs on your machine by following the instructions on the MkDocs site.
Use pip
(or sudo -H pip
) to install the latest version of the Material theme:
$ pip install mkdocs-material
Use pip
to install the PyMdown Extensions:
$ pip install pymdown-extensions
Clone this repo:
$ git clone https://github.com/cloudfoundry/docs-riff.git
Navigate to the repo on your machine.
Launch the MkDocs development server:
$ mkdocs serve
Navigate to localhost:8000
to see a local version of the documentation. The site will update automatically as you make changes to the Markdown files.