Installation

Step-by-step instructions

These steps also include the installation steps from the following packages:
- django-markdownx
- django-simple-history
- django-htmx
- Bootstrap 4 (required for modal functionality)
Please see each packages documentation for detailed installation/usage instructions.
Install the ‘django-easy-docs' package via pip:
```
 python -m pip install django-easy-docs
```

Add ‘easy_docs', ‘markdownx', ‘django_htmx', and ‘simple_history' to your INSTALLED_APPS in your settings.py file:

 INSTALLED_APPS = [
     ...
     'easy_docs',
     'markdownx',
     'django_htmx',
     'simple_history',
     ...
 ]
  

Add the following to your urls.py file:

 from django.urls import path, include

 urlpatterns = [
     ...
     path('markdownx/', include('markdownx.urls')), # We need this for the markdown editor/preview
     path('docs/', include('easy_docs.urls')),
     ...
 ]
  

Add the following to your middleware in your settings.py file:

 MIDDLEWARE = [
     ...
     'simple_history.middleware.HistoryRequestMiddleware',
     'easy_docs.middleware.CurrentUserMiddleware',
     'django_htmx.middleware.HtmxMiddleware',
     ...
 ]
  

Run the command below to apply the migrations for the ‘easy_docs' app:
```
 python manage.py migrate
```
Collect static files for proper rendering of the markdown editor/preview:
```
 python manage.py collectstatic
```

Add the following to your base template:

 {% load easy_docs_tags %}
 <head>
     ...
     {% load_dependencies %}
     ...
 </head>
  

Alternately, you can add the scripts for HTMX, Alpine JS, and easy docs CSS manually:

 {% load static %}
 <head>
     ...
     <script src="https://unpkg.com/htmx.org/dist/htmx.js"></script>
     <script src="https://cdnjs.cloudflare.com/ajax/libs/alpinejs/2.8.0/alpine.js"></script>
     <link href="{% static 'easy_docs/css/styles.css' %}" rel="stylesheet">
     ...
 </head>
  

Add Bootstrap 4 to your base template:

{% load static %}
<head>
    ...
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">

    <!-- Bootstrap CSS -->
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@4.0.0/dist/css/bootstrap.min.css" integrity="sha384-Gn5384xqQ1aoWXA+058RXPxPg6fy4IWvTNh0E263XmFcJlSAwiGgFAW/dAiS6JXm" crossorigin="anonymous">
    ...
</head>
<body>
    ...

<!-- Place at the bottom of the body -->
<!-- jQuery first, then Popper.js, then Bootstrap JS -->
<script src="https://code.jquery.com/jquery-3.2.1.slim.min.js" integrity="sha384-KJ3o2DKtIkvYIK3UENzmM7KCkRr/rE9/Qpg6aAZGJwFDMVNA/GpGFF93hXpG5KkN" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/popper.js@1.12.9/dist/umd/popper.min.js" integrity="sha384-ApNbgh9B+Y1QKtv3Rn7W3mgPxhU9K/ScQsAP7hUibX39j7fakFPskvXusvfa0b4Q" crossorigin="anonymous"></script>
<script src="https://cdn.jsdelivr.net/npm/bootstrap@4.0.0/dist/js/bootstrap.min.js" integrity="sha384-JZR6Spejh4U02d8jOt6vLEHfe/JQGiRRSQQxSfFWpi1MquVdAyjUar5+76PVCmYl" crossorigin="anonymous"></script>
</body>
  

Optionally, specify the following settings in your settings.py file:
```
# Optional settings
USE_REGEX = True
URL_MAP = [
    (r'/products/\d+/', '/products/detail'),
    (r'/orders/\d+/edit/', '/orders/edit'),
    (r'/users/\d+/profile/', '/users/profile'),
]
```
- USE_REGEX: Set to True to enable user-level URL mapping.
- URL_MAP: A list of tuples where the first element is a regular expression pattern that matches the dynamic URLs you want to map, and the second element is the replacement string that represents the generic URL pattern you want to map the dynamic URLs to. A more thorough explanation can be found in the Customizing the URL mapping section of the documentation.