Skip to content

Commit

Permalink
update mkdocs to include custom theme
Browse files Browse the repository at this point in the history
  • Loading branch information
abe-101 authored and jleclanche committed May 21, 2024
1 parent 4a9ec25 commit b2dff48
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 23 deletions.
2 changes: 1 addition & 1 deletion docs/assets/zemtu.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
85 changes: 63 additions & 22 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,46 @@
site_name: Dj-Stripe
site_url: https://dj-stripe.dev
site_description: Django + Stripe Made Easy
site_description: Stripe Made Easy for Django Developers
site_footer: The link between your Django project and stripe.
site_author: Dj-Stripe Team

copyright: Copyright © 2024. All Rights Reserved.

repo_name: dj-stripe
repo_url: https://github.com/dj-stripe/dj-stripe/


theme:
name: readthedocs
logo: assets/logo.svg
favicon: assets/favicon.png
icon:
repo: fontawesome/brands/github
font:
text: Helvetica
name: material
custom_dir: overrides
static_templates:
- 404.html
features:
- content.code.annotate
- navigation.indexes
- navigation.tabs
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- search.highligh
palette:
- media: "(prefers-color-scheme: light)" #
scheme: light
toggle:
icon: material/weather-night
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)" #
scheme: dark
toggle:
icon: material/weather-sunny
name: Switch to light mode


markdown_extensions:
- admonition
Expand All @@ -17,6 +49,9 @@ markdown_extensions:
- pymdownx.inlinehilite
- pymdownx.superfences
- pymdownx.snippets
- pymdownx.extra
- meta


plugins:
- autorefs
Expand All @@ -42,44 +77,50 @@ plugins:
canonical_version: "2.8"

nav:
- Home: README.md
- Sponsors: project/sponsors.md
- Getting Started:
- Documentation:
- Getting Started:
- Installation: installation.md
- Managing Stripe API Keys: api_keys.md
- A note on Stripe API Versions: api_versions.md
- Upgrade dj-stripe: upgrade_dj_stripe.md
- Integrating Stripe Elements: stripe_elements_js.md
- Upgrading Smooth and Carefully: upgrade_dj_stripe.md
- Release notes:
- dj-stripe 2.9 release notes: history/2_9_0.md
- dj-stripe 2.8 release notes: history/2_8_0.md
- dj-stripe 2.7 release notes: history/2_7_0.md
- dj-stripe 2.6 release notes: history/2_6_0.md
- dj-stripe 2.5 release notes: history/2_5_0.md
- dj-stripe 2.4.1 release notes: history/2_4_x.md
- dj-stripe 2.4 release notes: history/2_4_0.md
- dj-stripe 2.0 ~ 2.3 release notes: history/2_x.md
- dj-stripe 1.x release notes: history/1_x.md
- dj-stripe 0.x release notes: history/0_x.md
- Usage:
- Usage:
- Using Stripe Webhooks: usage/webhooks.md
- Local Webhook Testing: usage/local_webhook_testing.md
- Subscribing a customer to a plan: usage/subscribing_customers.md
- Add a payment method to customer: usage/add_payment_method_to_customer.md
- Managing subscriptions and payment sources: usage/managing_subscriptions.md
- Manually syncing data with Stripe: usage/manually_syncing_with_stripe.md
- Creating individual charges: usage/creating_individual_charges.md
- Creating Usage Records: usage/creating_usage_record.md
- Using Stripe Checkout: usage/using_stripe_checkout.md
- Using with Docker: usage/using_with_docker.md
- Development with local webhooks: usage/local_webhook_testing.md
- Project:
- Project:
- Contributing: project/contributing.md
- Test Fixtures: project/test_fixtures.md
- Credits: project/authors.md
- Support: project/support.md
- Release Process: project/release_process.md
- Reference:
- Reference:
- Enumerations: reference/enums.md
- Managers: reference/managers.md
- Models: reference/models.md
- Settings: reference/settings.md
- Utilities: reference/utils.md
- Tests: reference/project.md
- Sponsors:
- Our Sponsors: project/sponsors.md
- History:
- dj-stripe 3.0 release notes: history/3_0_0.md
- dj-stripe 2.9 release notes: history/2_9_0.md
- dj-stripe 2.8 release notes: history/2_8_x.md
- dj-stripe 2.7 release notes: history/2_7_x.md
- dj-stripe 2.6 release notes: history/2_6_x.md
- dj-stripe 2.5 release notes: history/2_5_x.md
- dj-stripe 2.4.1 release notes: history/2_4_x.md
- dj-stripe 2.4 release notes: history/2_4_0.md
- dj-stripe 2.0 ~ 2.3 release notes: history/2_x.md
- dj-stripe 1.x release notes: history/1_x.md
- dj-stripe 0.x release notes: history/0_x.md


0 comments on commit b2dff48

Please sign in to comment.