Skip to content

Use syntax highlighting in readme #1102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 10, 2022
Merged

Use syntax highlighting in readme #1102

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,9 @@ Overview
* Format specification: https://jsonapi.org/format/


By default, Django REST framework will produce a response like::
By default, Django REST framework will produce a response like:

.. code:: JSON

{
"count": 20,
Expand All @@ -39,7 +41,9 @@ By default, Django REST framework will produce a response like::


However, for an ``identity`` model in JSON:API format the response should look
like the following::
like the following:

.. code:: JSON

{
"links": {
Expand Down Expand Up @@ -104,7 +108,7 @@ Installation

Install using ``pip``...

::
.. code:: sh

$ pip install djangorestframework-jsonapi
$ # for optional package integrations
Expand All @@ -115,7 +119,7 @@ Install using ``pip``...

or from source...

::
.. code:: sh

$ git clone https://github.com/django-json-api/django-rest-framework-json-api.git
$ cd django-rest-framework-json-api
Expand All @@ -124,7 +128,7 @@ or from source...

and add ``rest_framework_json_api`` to your ``INSTALLED_APPS`` setting below ``rest_framework``.

::
.. code:: python

INSTALLED_APPS = [
...
Expand All @@ -140,7 +144,7 @@ Running the example app
It is recommended to create a virtualenv for testing. Assuming it is already
installed and activated:

::
.. code:: sh

$ git clone https://github.com/django-json-api/django-rest-framework-json-api.git
$ cd django-rest-framework-json-api
Expand Down Expand Up @@ -172,7 +176,7 @@ One can either add ``rest_framework_json_api.parsers.JSONParser`` and
``rest_framework_json_api.renderers.JSONRenderer`` to each ``ViewSet`` class, or
override ``settings.REST_FRAMEWORK``

::
.. code:: python

REST_FRAMEWORK = {
'PAGE_SIZE': 10,
Expand Down