Skip to content

Commit

Permalink
chore: fix docs site dark mode & security updates
Browse files Browse the repository at this point in the history
  • Loading branch information
datnguye committed Jan 12, 2024
1 parent a9ac577 commit 4eda823
Show file tree
Hide file tree
Showing 4 changed files with 448 additions and 455 deletions.
17 changes: 11 additions & 6 deletions docs/nav/development/contributing-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,20 @@

`dbterd` is open source software. It is what it is today because community members have opened issues, provided feedback, and contributed to the knowledge loop. Whether you are a seasoned open source contributor or a first-time committer, we welcome and encourage you to contribute code, documentation, ideas, or problem statements to this project.

1. [About this document](#about-this-document)
2. [Getting the code](#getting-the-code)
3. [Setting up an environment](#setting-up-an-environment)
4. [Testing dbterd](#testing)
5. [Submitting a Pull Request](#submitting-a-pull-request)
- [Contributing to `dbterd`](#contributing-to-dbterd)
- [About this document](#about-this-document)
- [Getting the code](#getting-the-code)
- [Installing git](#installing-git)
- [External contributors](#external-contributors)
- [Setting up an environment](#setting-up-an-environment)
- [Tools](#tools)
- [Testing](#testing)
- [`pytest`](#pytest)
- [Submitting a Pull Request](#submitting-a-pull-request)

## About this document

There are many ways to contribute to the ongoing development of `dbterd`, such as by participating in discussions and issues. We encourage you to first read our higher-level document: ["Expectations for Open Source Contributors"](add-document).
There are many ways to contribute to the ongoing development of `dbterd`, such as by participating in discussions and issues.

The rest of this document serves as a more granular guide for contributing code changes to `dbterd` (this repository). It is not intended as a guide for using `dbterd`, and some pieces assume a level of familiarity with Python development with `poetry`. Specific code snippets in this guide assume you are using macOS or Linux and are comfortable with the command line.

Expand Down
10 changes: 5 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ theme:
- search.share
- search.suggest
- toc.follow

palette:
- media: "(prefers-color-scheme)"
primary: black
Expand All @@ -70,7 +70,7 @@ theme:
toggle:
icon: material/brightness-4
name: Switch to system preference

font:
text: Roboto
code: Roboto Mono
Expand Down Expand Up @@ -143,10 +143,10 @@ markdown_extensions:
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.details:
- pymdownx.emoji:
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
Expand Down
Loading

0 comments on commit 4eda823

Please sign in to comment.